talon_one 1.1.0 → 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/README.md +21 -12
- data/docs/AccountAnalytics.md +1 -0
- data/docs/AccountLimits.md +1 -0
- data/docs/Application.md +2 -1
- data/docs/ApplicationCustomer.md +1 -1
- data/docs/ApplicationSession.md +2 -1
- data/docs/Attribute.md +0 -2
- data/docs/AttributesMandatory.md +9 -0
- data/docs/AttributesSettings.md +8 -0
- data/docs/BaseSamlConnection.md +15 -0
- data/docs/Campaign.md +2 -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/CustomerProfile.md +1 -1
- data/docs/ErrorSource.md +1 -0
- data/docs/Event.md +1 -1
- 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 +1 -1
- 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/IntegrationEvent.md +10 -0
- data/docs/IntegrationState.md +1 -0
- data/docs/ManagementApi.md +175 -104
- data/docs/Meta.md +1 -0
- data/docs/NewApplication.md +2 -1
- data/docs/NewEvent.md +1 -1
- data/docs/NewSamlConnection.md +16 -0
- data/docs/Notification.md +10 -0
- data/docs/{ApplicationStorageData.md → Notifications.md} +1 -1
- data/docs/ReferralRejectionReason.md +10 -0
- data/docs/SamlConnection.md +18 -0
- data/docs/SamlConnectionMetadata.md +11 -0
- data/docs/UpdateApplication.md +15 -0
- data/docs/UpdateUser.md +1 -0
- data/docs/User.md +2 -0
- data/docs/Webhook.md +0 -1
- data/lib/talon_one.rb +13 -6
- data/lib/talon_one/api/integration_api.rb +60 -0
- data/lib/talon_one/api/management_api.rb +194 -121
- 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 +62 -53
- data/lib/talon_one/models/application_customer.rb +0 -5
- data/lib/talon_one/models/application_session.rb +12 -2
- data/lib/talon_one/models/attribute.rb +4 -38
- data/lib/talon_one/models/attributes_mandatory.rb +199 -0
- data/lib/talon_one/models/{new_application_storage_data.rb → attributes_settings.rb} +13 -4
- data/lib/talon_one/models/{application_storage.rb → base_saml_connection.rb} +122 -78
- data/lib/talon_one/models/campaign.rb +21 -1
- 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/coupon_rejection_reason.rb +2 -2
- data/lib/talon_one/models/customer_inventory.rb +194 -0
- data/lib/talon_one/models/customer_profile.rb +0 -5
- data/lib/talon_one/models/error_source.rb +14 -4
- data/lib/talon_one/models/event.rb +11 -35
- 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 +1 -1
- 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/{new_application_storage_tuple.rb → inline_response_200_29.rb} +22 -40
- data/lib/talon_one/models/integration_event.rb +234 -0
- data/lib/talon_one/models/integration_state.rb +13 -4
- data/lib/talon_one/models/limit_config.rb +2 -2
- data/lib/talon_one/models/meta.rb +10 -1
- data/lib/talon_one/models/new_application.rb +57 -56
- data/lib/talon_one/models/new_event.rb +38 -38
- data/lib/talon_one/models/new_saml_connection.rb +371 -0
- data/lib/talon_one/models/{new_application_storage.rb → notification.rb} +22 -17
- data/lib/talon_one/models/{application_storage_data.rb → notifications.rb} +1 -2
- data/lib/talon_one/models/referral_rejection_reason.rb +251 -0
- data/lib/talon_one/models/saml_connection.rb +387 -0
- data/lib/talon_one/models/{application_storage_tuple.rb → saml_connection_metadata.rb} +68 -80
- data/lib/talon_one/models/update_application.rb +361 -0
- data/lib/talon_one/models/update_user.rb +13 -4
- data/lib/talon_one/models/user.rb +23 -4
- data/lib/talon_one/models/webhook.rb +4 -21
- data/lib/talon_one/version.rb +1 -1
- data/spec/api/integration_api_spec.rb +14 -0
- data/spec/api/management_api_spec.rb +56 -37
- data/spec/models/account_analytics_spec.rb +6 -0
- data/spec/models/account_limits_spec.rb +6 -0
- data/spec/models/application_session_spec.rb +6 -0
- data/spec/models/application_spec.rb +12 -6
- data/spec/models/attribute_spec.rb +0 -12
- data/spec/models/{new_application_storage_tuple_spec.rb → attributes_mandatory_spec.rb} +8 -8
- data/spec/models/{new_application_storage_data_spec.rb → attributes_settings_spec.rb} +12 -6
- data/spec/models/{application_storage_spec.rb → base_saml_connection_spec.rb} +14 -14
- data/spec/models/campaign_analytics_spec.rb +36 -0
- data/spec/models/campaign_copy_spec.rb +24 -0
- data/spec/models/campaign_spec.rb +12 -0
- data/spec/models/coupon_rejection_reason_spec.rb +1 -1
- data/spec/models/customer_inventory_spec.rb +47 -0
- data/spec/models/error_source_spec.rb +6 -0
- data/spec/models/event_spec.rb +3 -3
- 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/integration_event_spec.rb +53 -0
- data/spec/models/integration_state_spec.rb +6 -0
- data/spec/models/limit_config_spec.rb +1 -1
- data/spec/models/meta_spec.rb +6 -0
- data/spec/models/new_application_spec.rb +12 -6
- data/spec/models/new_event_spec.rb +3 -3
- data/spec/models/new_saml_connection_spec.rb +89 -0
- data/spec/models/{new_application_storage_spec.rb → notification_spec.rb} +8 -8
- data/spec/models/{application_storage_data_spec.rb → notifications_spec.rb} +6 -6
- data/spec/models/referral_rejection_reason_spec.rb +57 -0
- data/spec/models/{application_storage_tuple_spec.rb → saml_connection_metadata_spec.rb} +10 -22
- data/spec/models/saml_connection_spec.rb +101 -0
- data/spec/models/update_application_spec.rb +87 -0
- data/spec/models/update_user_spec.rb +6 -0
- data/spec/models/user_spec.rb +12 -0
- data/spec/models/webhook_spec.rb +0 -6
- data/talon_one-1.0.0.gem +0 -0
- data/talon_one-1.1.0.gem +0 -0
- data/talon_one-1.1.1.gem +0 -0
- data/talon_one-1.1.2.gem +0 -0
- data/talon_one-1.2.0.gem +0 -0
- data/talon_one-1.3.0.gem +0 -0
- data/talon_one.gemspec +1 -1
- metadata +74 -42
- data/docs/ApplicationStorage.md +0 -15
- data/docs/ApplicationStorageTuple.md +0 -13
- data/docs/NewApplicationStorage.md +0 -10
- data/docs/NewApplicationStorageData.md +0 -7
- data/docs/NewApplicationStorageTuple.md +0 -9
- data/fck.rb +0 -64
@@ -42,6 +42,8 @@ module TalonOne
|
|
42
42
|
# Update
|
43
43
|
attr_accessor :roles
|
44
44
|
|
45
|
+
attr_accessor :application_notification_subscriptions
|
46
|
+
|
45
47
|
class EnumAttributeValidator
|
46
48
|
attr_reader :datatype
|
47
49
|
attr_reader :allowable_values
|
@@ -75,7 +77,8 @@ module TalonOne
|
|
75
77
|
:'state' => :'state',
|
76
78
|
:'release_update' => :'releaseUpdate',
|
77
79
|
:'latest_feature' => :'latestFeature',
|
78
|
-
:'roles' => :'roles'
|
80
|
+
:'roles' => :'roles',
|
81
|
+
:'application_notification_subscriptions' => :'applicationNotificationSubscriptions'
|
79
82
|
}
|
80
83
|
end
|
81
84
|
|
@@ -90,7 +93,8 @@ module TalonOne
|
|
90
93
|
:'state' => :'String',
|
91
94
|
:'release_update' => :'BOOLEAN',
|
92
95
|
:'latest_feature' => :'String',
|
93
|
-
:'roles' => :'Array<Integer>'
|
96
|
+
:'roles' => :'Array<Integer>',
|
97
|
+
:'application_notification_subscriptions' => :'Object'
|
94
98
|
}
|
95
99
|
end
|
96
100
|
|
@@ -139,6 +143,10 @@ module TalonOne
|
|
139
143
|
self.roles = value
|
140
144
|
end
|
141
145
|
end
|
146
|
+
|
147
|
+
if attributes.has_key?(:'applicationNotificationSubscriptions')
|
148
|
+
self.application_notification_subscriptions = attributes[:'applicationNotificationSubscriptions']
|
149
|
+
end
|
142
150
|
end
|
143
151
|
|
144
152
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -184,7 +192,8 @@ module TalonOne
|
|
184
192
|
state == o.state &&
|
185
193
|
release_update == o.release_update &&
|
186
194
|
latest_feature == o.latest_feature &&
|
187
|
-
roles == o.roles
|
195
|
+
roles == o.roles &&
|
196
|
+
application_notification_subscriptions == o.application_notification_subscriptions
|
188
197
|
end
|
189
198
|
|
190
199
|
# @see the `==` method
|
@@ -196,7 +205,7 @@ module TalonOne
|
|
196
205
|
# Calculates hash code according to all attributes.
|
197
206
|
# @return [Fixnum] Hash code
|
198
207
|
def hash
|
199
|
-
[email, name, password, new_password, policy, state, release_update, latest_feature, roles].hash
|
208
|
+
[email, name, password, new_password, policy, state, release_update, latest_feature, roles, application_notification_subscriptions].hash
|
200
209
|
end
|
201
210
|
|
202
211
|
# Builds the object from hash
|
@@ -51,6 +51,11 @@ module TalonOne
|
|
51
51
|
# Contains a list of all roles a user is a memeber of
|
52
52
|
attr_accessor :roles
|
53
53
|
|
54
|
+
attr_accessor :application_notification_subscriptions
|
55
|
+
|
56
|
+
# The Authentication method for this user
|
57
|
+
attr_accessor :auth_method
|
58
|
+
|
54
59
|
class EnumAttributeValidator
|
55
60
|
attr_reader :datatype
|
56
61
|
attr_reader :allowable_values
|
@@ -87,7 +92,9 @@ module TalonOne
|
|
87
92
|
:'policy' => :'policy',
|
88
93
|
:'release_update' => :'releaseUpdate',
|
89
94
|
:'latest_feature' => :'latestFeature',
|
90
|
-
:'roles' => :'roles'
|
95
|
+
:'roles' => :'roles',
|
96
|
+
:'application_notification_subscriptions' => :'applicationNotificationSubscriptions',
|
97
|
+
:'auth_method' => :'authMethod'
|
91
98
|
}
|
92
99
|
end
|
93
100
|
|
@@ -105,7 +112,9 @@ module TalonOne
|
|
105
112
|
:'policy' => :'String',
|
106
113
|
:'release_update' => :'BOOLEAN',
|
107
114
|
:'latest_feature' => :'String',
|
108
|
-
:'roles' => :'Array<Integer>'
|
115
|
+
:'roles' => :'Array<Integer>',
|
116
|
+
:'application_notification_subscriptions' => :'Object',
|
117
|
+
:'auth_method' => :'String'
|
109
118
|
}
|
110
119
|
end
|
111
120
|
|
@@ -166,6 +175,14 @@ module TalonOne
|
|
166
175
|
self.roles = value
|
167
176
|
end
|
168
177
|
end
|
178
|
+
|
179
|
+
if attributes.has_key?(:'applicationNotificationSubscriptions')
|
180
|
+
self.application_notification_subscriptions = attributes[:'applicationNotificationSubscriptions']
|
181
|
+
end
|
182
|
+
|
183
|
+
if attributes.has_key?(:'authMethod')
|
184
|
+
self.auth_method = attributes[:'authMethod']
|
185
|
+
end
|
169
186
|
end
|
170
187
|
|
171
188
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -259,7 +276,9 @@ module TalonOne
|
|
259
276
|
policy == o.policy &&
|
260
277
|
release_update == o.release_update &&
|
261
278
|
latest_feature == o.latest_feature &&
|
262
|
-
roles == o.roles
|
279
|
+
roles == o.roles &&
|
280
|
+
application_notification_subscriptions == o.application_notification_subscriptions &&
|
281
|
+
auth_method == o.auth_method
|
263
282
|
end
|
264
283
|
|
265
284
|
# @see the `==` method
|
@@ -271,7 +290,7 @@ module TalonOne
|
|
271
290
|
# Calculates hash code according to all attributes.
|
272
291
|
# @return [Fixnum] Hash code
|
273
292
|
def hash
|
274
|
-
[id, created, modified, email, account_id, invite_token, state, name, policy, release_update, latest_feature, roles].hash
|
293
|
+
[id, created, modified, email, account_id, invite_token, state, name, policy, release_update, latest_feature, roles, application_notification_subscriptions, auth_method].hash
|
275
294
|
end
|
276
295
|
|
277
296
|
# Builds the object from hash
|
@@ -48,9 +48,6 @@ module TalonOne
|
|
48
48
|
# Enables or disables webhook from showing in rule builder
|
49
49
|
attr_accessor :enabled
|
50
50
|
|
51
|
-
# array of rulesets where webhook is used
|
52
|
-
attr_accessor :used_at
|
53
|
-
|
54
51
|
class EnumAttributeValidator
|
55
52
|
attr_reader :datatype
|
56
53
|
attr_reader :allowable_values
|
@@ -86,8 +83,7 @@ module TalonOne
|
|
86
83
|
:'headers' => :'headers',
|
87
84
|
:'payload' => :'payload',
|
88
85
|
:'params' => :'params',
|
89
|
-
:'enabled' => :'enabled'
|
90
|
-
:'used_at' => :'usedAt'
|
86
|
+
:'enabled' => :'enabled'
|
91
87
|
}
|
92
88
|
end
|
93
89
|
|
@@ -104,8 +100,7 @@ module TalonOne
|
|
104
100
|
:'headers' => :'Array<String>',
|
105
101
|
:'payload' => :'String',
|
106
102
|
:'params' => :'Array<TemplateArgDef>',
|
107
|
-
:'enabled' => :'BOOLEAN'
|
108
|
-
:'used_at' => :'Array<String>'
|
103
|
+
:'enabled' => :'BOOLEAN'
|
109
104
|
}
|
110
105
|
end
|
111
106
|
|
@@ -166,12 +161,6 @@ module TalonOne
|
|
166
161
|
if attributes.has_key?(:'enabled')
|
167
162
|
self.enabled = attributes[:'enabled']
|
168
163
|
end
|
169
|
-
|
170
|
-
if attributes.has_key?(:'usedAt')
|
171
|
-
if (value = attributes[:'usedAt']).is_a?(Array)
|
172
|
-
self.used_at = value
|
173
|
-
end
|
174
|
-
end
|
175
164
|
end
|
176
165
|
|
177
166
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -218,10 +207,6 @@ module TalonOne
|
|
218
207
|
invalid_properties.push('invalid value for "enabled", enabled cannot be nil.')
|
219
208
|
end
|
220
209
|
|
221
|
-
if @used_at.nil?
|
222
|
-
invalid_properties.push('invalid value for "used_at", used_at cannot be nil.')
|
223
|
-
end
|
224
|
-
|
225
210
|
invalid_properties
|
226
211
|
end
|
227
212
|
|
@@ -240,7 +225,6 @@ module TalonOne
|
|
240
225
|
return false if @headers.nil?
|
241
226
|
return false if @params.nil?
|
242
227
|
return false if @enabled.nil?
|
243
|
-
return false if @used_at.nil?
|
244
228
|
true
|
245
229
|
end
|
246
230
|
|
@@ -269,8 +253,7 @@ module TalonOne
|
|
269
253
|
headers == o.headers &&
|
270
254
|
payload == o.payload &&
|
271
255
|
params == o.params &&
|
272
|
-
enabled == o.enabled
|
273
|
-
used_at == o.used_at
|
256
|
+
enabled == o.enabled
|
274
257
|
end
|
275
258
|
|
276
259
|
# @see the `==` method
|
@@ -282,7 +265,7 @@ module TalonOne
|
|
282
265
|
# Calculates hash code according to all attributes.
|
283
266
|
# @return [Fixnum] Hash code
|
284
267
|
def hash
|
285
|
-
[id, created, modified, application_ids, title, verb, url, headers, payload, params, enabled
|
268
|
+
[id, created, modified, application_ids, title, verb, url, headers, payload, params, enabled].hash
|
286
269
|
end
|
287
270
|
|
288
271
|
# Builds the object from hash
|
data/lib/talon_one/version.rb
CHANGED
@@ -82,6 +82,20 @@ describe 'IntegrationApi' do
|
|
82
82
|
end
|
83
83
|
end
|
84
84
|
|
85
|
+
# unit tests for get_customer_inventory
|
86
|
+
# Get an inventory of all data associated with a specific customer profile.
|
87
|
+
# 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.
|
88
|
+
# @param integration_id The custom identifier for this profile, must be unique within the account.
|
89
|
+
# @param [Hash] opts the optional parameters
|
90
|
+
# @option opts [Object] :profile optional flag to decide if you would like customer profile information in the response
|
91
|
+
# @option opts [Object] :referrals optional flag to decide if you would like referral information in the response
|
92
|
+
# @return [CustomerInventory]
|
93
|
+
describe 'get_customer_inventory test' do
|
94
|
+
it 'should work' do
|
95
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
85
99
|
# unit tests for get_reserved_coupons
|
86
100
|
# Get all valid reserved coupons
|
87
101
|
# Returns all coupons this user is subscribed to that are valid and usable
|
@@ -60,6 +60,18 @@ describe 'ManagementApi' do
|
|
60
60
|
end
|
61
61
|
end
|
62
62
|
|
63
|
+
# unit tests for create_attribute
|
64
|
+
# Define a new custom attribute
|
65
|
+
# 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.
|
66
|
+
# @param body
|
67
|
+
# @param [Hash] opts the optional parameters
|
68
|
+
# @return [Attribute]
|
69
|
+
describe 'create_attribute test' do
|
70
|
+
it 'should work' do
|
71
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
72
|
+
end
|
73
|
+
end
|
74
|
+
|
63
75
|
# unit tests for create_campaign
|
64
76
|
# Create a Campaign
|
65
77
|
#
|
@@ -75,7 +87,7 @@ describe 'ManagementApi' do
|
|
75
87
|
|
76
88
|
# unit tests for create_coupons
|
77
89
|
# Create Coupons
|
78
|
-
# 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
|
90
|
+
# 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.
|
79
91
|
# @param application_id
|
80
92
|
# @param campaign_id
|
81
93
|
# @param body
|
@@ -214,8 +226,8 @@ describe 'ManagementApi' do
|
|
214
226
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
215
227
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
216
228
|
# @param [Hash] opts the optional parameters
|
217
|
-
# @option opts [String] :path Only return results where the request path matches the given regular
|
218
|
-
# @option opts [String] :method Only return results where the request method matches the given regular
|
229
|
+
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
230
|
+
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
219
231
|
# @option opts [String] :status Filter results by HTTP status codes.
|
220
232
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
221
233
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -234,8 +246,8 @@ describe 'ManagementApi' do
|
|
234
246
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
235
247
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
236
248
|
# @param [Hash] opts the optional parameters
|
237
|
-
# @option opts [String] :path Only return results where the request path matches the given regular
|
238
|
-
# @option opts [String] :method Only return results where the request method matches the given regular
|
249
|
+
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
250
|
+
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
239
251
|
# @option opts [String] :status Filter results by HTTP status codes.
|
240
252
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
241
253
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -271,26 +283,14 @@ describe 'ManagementApi' do
|
|
271
283
|
end
|
272
284
|
end
|
273
285
|
|
274
|
-
# unit tests for get_account_limits
|
275
|
-
# Get Account Limits
|
276
|
-
# Returns a list of all account limits set
|
277
|
-
# @param account_id
|
278
|
-
# @param [Hash] opts the optional parameters
|
279
|
-
# @return [AccountLimits]
|
280
|
-
describe 'get_account_limits test' do
|
281
|
-
it 'should work' do
|
282
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
283
|
-
end
|
284
|
-
end
|
285
|
-
|
286
286
|
# unit tests for get_all_access_logs
|
287
287
|
# Get all access logs
|
288
288
|
# Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
|
289
289
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
290
290
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
291
291
|
# @param [Hash] opts the optional parameters
|
292
|
-
# @option opts [String] :path Only return results where the request path matches the given regular
|
293
|
-
# @option opts [String] :method Only return results where the request method matches the given regular
|
292
|
+
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
293
|
+
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
294
294
|
# @option opts [String] :status Filter results by HTTP status codes.
|
295
295
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
296
296
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -305,7 +305,7 @@ describe 'ManagementApi' do
|
|
305
305
|
# unit tests for get_all_roles
|
306
306
|
# Get all roles.
|
307
307
|
# @param [Hash] opts the optional parameters
|
308
|
-
# @return [
|
308
|
+
# @return [InlineResponse20029]
|
309
309
|
describe 'get_all_roles test' do
|
310
310
|
it 'should work' do
|
311
311
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -363,7 +363,7 @@ describe 'ManagementApi' do
|
|
363
363
|
|
364
364
|
# unit tests for get_application_customers_by_attributes
|
365
365
|
# Get a list of the customer profiles that match the given attributes
|
366
|
-
# 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]:
|
366
|
+
# 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
|
367
367
|
# @param body
|
368
368
|
# @param [Hash] opts the optional parameters
|
369
369
|
# @return [InlineResponse20013]
|
@@ -497,6 +497,20 @@ describe 'ManagementApi' do
|
|
497
497
|
end
|
498
498
|
end
|
499
499
|
|
500
|
+
# unit tests for get_attributes
|
501
|
+
# List custom attributes
|
502
|
+
# Returns all the defined custom attributes for the account.
|
503
|
+
# @param [Hash] opts the optional parameters
|
504
|
+
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
505
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
506
|
+
# @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.
|
507
|
+
# @return [InlineResponse20020]
|
508
|
+
describe 'get_attributes test' do
|
509
|
+
it 'should work' do
|
510
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
511
|
+
end
|
512
|
+
end
|
513
|
+
|
500
514
|
# unit tests for get_campaign
|
501
515
|
# Get a Campaign
|
502
516
|
#
|
@@ -513,7 +527,7 @@ describe 'ManagementApi' do
|
|
513
527
|
# unit tests for get_campaign_analytics
|
514
528
|
# Get analytics of campaigns
|
515
529
|
#
|
516
|
-
# @param application_id
|
530
|
+
# @param application_id
|
517
531
|
# @param campaign_id
|
518
532
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
519
533
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
@@ -582,7 +596,12 @@ describe 'ManagementApi' do
|
|
582
596
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
583
597
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
584
598
|
# @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.
|
585
|
-
# @
|
599
|
+
# @option opts [Integer] :application_id
|
600
|
+
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
|
601
|
+
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
|
602
|
+
# @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.
|
603
|
+
# @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.
|
604
|
+
# @return [InlineResponse20026]
|
586
605
|
describe 'get_changes test' do
|
587
606
|
it 'should work' do
|
588
607
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -798,7 +817,7 @@ describe 'ManagementApi' do
|
|
798
817
|
|
799
818
|
# unit tests for get_customers_by_attributes
|
800
819
|
# Get a list of the customer profiles that match the given attributes
|
801
|
-
# 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]:
|
820
|
+
# 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
|
802
821
|
# @param body
|
803
822
|
# @param [Hash] opts the optional parameters
|
804
823
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
@@ -820,7 +839,7 @@ describe 'ManagementApi' do
|
|
820
839
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
821
840
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
822
841
|
# @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.
|
823
|
-
# @return [
|
842
|
+
# @return [InlineResponse20024]
|
824
843
|
describe 'get_event_types test' do
|
825
844
|
it 'should work' do
|
826
845
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -836,7 +855,7 @@ describe 'ManagementApi' do
|
|
836
855
|
# @option opts [Integer] :application_id
|
837
856
|
# @option opts [Integer] :campaign_id
|
838
857
|
# @option opts [String] :entity The name of the entity type that was exported.
|
839
|
-
# @return [
|
858
|
+
# @return [InlineResponse20027]
|
840
859
|
describe 'get_exports test' do
|
841
860
|
it 'should work' do
|
842
861
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -849,7 +868,7 @@ describe 'ManagementApi' do
|
|
849
868
|
# @param [Hash] opts the optional parameters
|
850
869
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
851
870
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
852
|
-
# @return [
|
871
|
+
# @return [InlineResponse20028]
|
853
872
|
describe 'get_imports test' do
|
854
873
|
it 'should work' do
|
855
874
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -996,7 +1015,7 @@ describe 'ManagementApi' do
|
|
996
1015
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
997
1016
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
998
1017
|
# @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.
|
999
|
-
# @return [
|
1018
|
+
# @return [InlineResponse20025]
|
1000
1019
|
describe 'get_users test' do
|
1001
1020
|
it 'should work' do
|
1002
1021
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1028,7 +1047,7 @@ describe 'ManagementApi' do
|
|
1028
1047
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
1029
1048
|
# @option opts [DateTime] :created_before Only return events created before this date.
|
1030
1049
|
# @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.
|
1031
|
-
# @return [
|
1050
|
+
# @return [InlineResponse20022]
|
1032
1051
|
describe 'get_webhook_activation_logs test' do
|
1033
1052
|
it 'should work' do
|
1034
1053
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1049,7 +1068,7 @@ describe 'ManagementApi' do
|
|
1049
1068
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
1050
1069
|
# @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.
|
1051
1070
|
# @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.
|
1052
|
-
# @return [
|
1071
|
+
# @return [InlineResponse20023]
|
1053
1072
|
describe 'get_webhook_logs test' do
|
1054
1073
|
it 'should work' do
|
1055
1074
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1064,7 +1083,7 @@ describe 'ManagementApi' do
|
|
1064
1083
|
# @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.
|
1065
1084
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1066
1085
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1067
|
-
# @return [
|
1086
|
+
# @return [InlineResponse20021]
|
1068
1087
|
describe 'get_webhooks test' do
|
1069
1088
|
it 'should work' do
|
1070
1089
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1212,14 +1231,14 @@ describe 'ManagementApi' do
|
|
1212
1231
|
end
|
1213
1232
|
end
|
1214
1233
|
|
1215
|
-
# unit tests for
|
1216
|
-
#
|
1217
|
-
#
|
1218
|
-
# @param
|
1234
|
+
# unit tests for update_attribute
|
1235
|
+
# Update a custom attribute
|
1236
|
+
# 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.
|
1237
|
+
# @param attribute_id
|
1219
1238
|
# @param body
|
1220
1239
|
# @param [Hash] opts the optional parameters
|
1221
|
-
# @return [
|
1222
|
-
describe '
|
1240
|
+
# @return [Attribute]
|
1241
|
+
describe 'update_attribute test' do
|
1223
1242
|
it 'should work' do
|
1224
1243
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1225
1244
|
end
|