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.
Files changed (143) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +21 -12
  3. data/docs/AccountAnalytics.md +1 -0
  4. data/docs/AccountLimits.md +1 -0
  5. data/docs/Application.md +2 -1
  6. data/docs/ApplicationCustomer.md +1 -1
  7. data/docs/ApplicationSession.md +2 -1
  8. data/docs/Attribute.md +0 -2
  9. data/docs/AttributesMandatory.md +9 -0
  10. data/docs/AttributesSettings.md +8 -0
  11. data/docs/BaseSamlConnection.md +15 -0
  12. data/docs/Campaign.md +2 -0
  13. data/docs/CampaignAnalytics.md +9 -3
  14. data/docs/CampaignCopy.md +4 -0
  15. data/docs/Change.md +2 -2
  16. data/docs/CustomerInventory.md +9 -0
  17. data/docs/CustomerProfile.md +1 -1
  18. data/docs/ErrorSource.md +1 -0
  19. data/docs/Event.md +1 -1
  20. data/docs/InlineResponse20020.md +1 -1
  21. data/docs/InlineResponse20021.md +1 -1
  22. data/docs/InlineResponse20022.md +1 -1
  23. data/docs/InlineResponse20023.md +1 -1
  24. data/docs/InlineResponse20024.md +1 -1
  25. data/docs/InlineResponse20025.md +1 -1
  26. data/docs/InlineResponse20026.md +3 -2
  27. data/docs/InlineResponse20027.md +1 -1
  28. data/docs/InlineResponse20028.md +1 -1
  29. data/docs/InlineResponse20029.md +9 -0
  30. data/docs/IntegrationApi.md +66 -0
  31. data/docs/IntegrationEvent.md +10 -0
  32. data/docs/IntegrationState.md +1 -0
  33. data/docs/ManagementApi.md +175 -104
  34. data/docs/Meta.md +1 -0
  35. data/docs/NewApplication.md +2 -1
  36. data/docs/NewEvent.md +1 -1
  37. data/docs/NewSamlConnection.md +16 -0
  38. data/docs/Notification.md +10 -0
  39. data/docs/{ApplicationStorageData.md → Notifications.md} +1 -1
  40. data/docs/ReferralRejectionReason.md +10 -0
  41. data/docs/SamlConnection.md +18 -0
  42. data/docs/SamlConnectionMetadata.md +11 -0
  43. data/docs/UpdateApplication.md +15 -0
  44. data/docs/UpdateUser.md +1 -0
  45. data/docs/User.md +2 -0
  46. data/docs/Webhook.md +0 -1
  47. data/lib/talon_one.rb +13 -6
  48. data/lib/talon_one/api/integration_api.rb +60 -0
  49. data/lib/talon_one/api/management_api.rb +194 -121
  50. data/lib/talon_one/models/account_analytics.rb +19 -4
  51. data/lib/talon_one/models/account_limits.rb +11 -1
  52. data/lib/talon_one/models/application.rb +62 -53
  53. data/lib/talon_one/models/application_customer.rb +0 -5
  54. data/lib/talon_one/models/application_session.rb +12 -2
  55. data/lib/talon_one/models/attribute.rb +4 -38
  56. data/lib/talon_one/models/attributes_mandatory.rb +199 -0
  57. data/lib/talon_one/models/{new_application_storage_data.rb → attributes_settings.rb} +13 -4
  58. data/lib/talon_one/models/{application_storage.rb → base_saml_connection.rb} +122 -78
  59. data/lib/talon_one/models/campaign.rb +21 -1
  60. data/lib/talon_one/models/campaign_analytics.rb +94 -4
  61. data/lib/talon_one/models/campaign_copy.rb +46 -4
  62. data/lib/talon_one/models/change.rb +2 -2
  63. data/lib/talon_one/models/coupon_rejection_reason.rb +2 -2
  64. data/lib/talon_one/models/customer_inventory.rb +194 -0
  65. data/lib/talon_one/models/customer_profile.rb +0 -5
  66. data/lib/talon_one/models/error_source.rb +14 -4
  67. data/lib/talon_one/models/event.rb +11 -35
  68. data/lib/talon_one/models/inline_response_200_20.rb +1 -1
  69. data/lib/talon_one/models/inline_response_200_21.rb +1 -1
  70. data/lib/talon_one/models/inline_response_200_22.rb +1 -1
  71. data/lib/talon_one/models/inline_response_200_23.rb +1 -1
  72. data/lib/talon_one/models/inline_response_200_24.rb +1 -1
  73. data/lib/talon_one/models/inline_response_200_25.rb +1 -1
  74. data/lib/talon_one/models/inline_response_200_26.rb +11 -7
  75. data/lib/talon_one/models/inline_response_200_27.rb +1 -1
  76. data/lib/talon_one/models/inline_response_200_28.rb +1 -1
  77. data/lib/talon_one/models/{new_application_storage_tuple.rb → inline_response_200_29.rb} +22 -40
  78. data/lib/talon_one/models/integration_event.rb +234 -0
  79. data/lib/talon_one/models/integration_state.rb +13 -4
  80. data/lib/talon_one/models/limit_config.rb +2 -2
  81. data/lib/talon_one/models/meta.rb +10 -1
  82. data/lib/talon_one/models/new_application.rb +57 -56
  83. data/lib/talon_one/models/new_event.rb +38 -38
  84. data/lib/talon_one/models/new_saml_connection.rb +371 -0
  85. data/lib/talon_one/models/{new_application_storage.rb → notification.rb} +22 -17
  86. data/lib/talon_one/models/{application_storage_data.rb → notifications.rb} +1 -2
  87. data/lib/talon_one/models/referral_rejection_reason.rb +251 -0
  88. data/lib/talon_one/models/saml_connection.rb +387 -0
  89. data/lib/talon_one/models/{application_storage_tuple.rb → saml_connection_metadata.rb} +68 -80
  90. data/lib/talon_one/models/update_application.rb +361 -0
  91. data/lib/talon_one/models/update_user.rb +13 -4
  92. data/lib/talon_one/models/user.rb +23 -4
  93. data/lib/talon_one/models/webhook.rb +4 -21
  94. data/lib/talon_one/version.rb +1 -1
  95. data/spec/api/integration_api_spec.rb +14 -0
  96. data/spec/api/management_api_spec.rb +56 -37
  97. data/spec/models/account_analytics_spec.rb +6 -0
  98. data/spec/models/account_limits_spec.rb +6 -0
  99. data/spec/models/application_session_spec.rb +6 -0
  100. data/spec/models/application_spec.rb +12 -6
  101. data/spec/models/attribute_spec.rb +0 -12
  102. data/spec/models/{new_application_storage_tuple_spec.rb → attributes_mandatory_spec.rb} +8 -8
  103. data/spec/models/{new_application_storage_data_spec.rb → attributes_settings_spec.rb} +12 -6
  104. data/spec/models/{application_storage_spec.rb → base_saml_connection_spec.rb} +14 -14
  105. data/spec/models/campaign_analytics_spec.rb +36 -0
  106. data/spec/models/campaign_copy_spec.rb +24 -0
  107. data/spec/models/campaign_spec.rb +12 -0
  108. data/spec/models/coupon_rejection_reason_spec.rb +1 -1
  109. data/spec/models/customer_inventory_spec.rb +47 -0
  110. data/spec/models/error_source_spec.rb +6 -0
  111. data/spec/models/event_spec.rb +3 -3
  112. data/spec/models/inline_response_200_26_spec.rb +6 -0
  113. data/spec/models/inline_response_200_29_spec.rb +47 -0
  114. data/spec/models/integration_event_spec.rb +53 -0
  115. data/spec/models/integration_state_spec.rb +6 -0
  116. data/spec/models/limit_config_spec.rb +1 -1
  117. data/spec/models/meta_spec.rb +6 -0
  118. data/spec/models/new_application_spec.rb +12 -6
  119. data/spec/models/new_event_spec.rb +3 -3
  120. data/spec/models/new_saml_connection_spec.rb +89 -0
  121. data/spec/models/{new_application_storage_spec.rb → notification_spec.rb} +8 -8
  122. data/spec/models/{application_storage_data_spec.rb → notifications_spec.rb} +6 -6
  123. data/spec/models/referral_rejection_reason_spec.rb +57 -0
  124. data/spec/models/{application_storage_tuple_spec.rb → saml_connection_metadata_spec.rb} +10 -22
  125. data/spec/models/saml_connection_spec.rb +101 -0
  126. data/spec/models/update_application_spec.rb +87 -0
  127. data/spec/models/update_user_spec.rb +6 -0
  128. data/spec/models/user_spec.rb +12 -0
  129. data/spec/models/webhook_spec.rb +0 -6
  130. data/talon_one-1.0.0.gem +0 -0
  131. data/talon_one-1.1.0.gem +0 -0
  132. data/talon_one-1.1.1.gem +0 -0
  133. data/talon_one-1.1.2.gem +0 -0
  134. data/talon_one-1.2.0.gem +0 -0
  135. data/talon_one-1.3.0.gem +0 -0
  136. data/talon_one.gemspec +1 -1
  137. metadata +74 -42
  138. data/docs/ApplicationStorage.md +0 -15
  139. data/docs/ApplicationStorageTuple.md +0 -13
  140. data/docs/NewApplicationStorage.md +0 -10
  141. data/docs/NewApplicationStorageData.md +0 -7
  142. data/docs/NewApplicationStorageTuple.md +0 -9
  143. data/fck.rb +0 -64
@@ -8,6 +8,7 @@ Method | HTTP request | Description
8
8
  [**create_referral**](IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create a referral code for an advocate
9
9
  [**delete_coupon_reservation**](IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
10
10
  [**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer.
11
+ [**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile.
11
12
  [**get_reserved_coupons**](IntegrationApi.md#get_reserved_coupons) | **GET** /v1/coupon_reservations/coupons/{integrationId} | Get all valid reserved coupons
12
13
  [**get_reserved_customers**](IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
13
14
  [**track_event**](IntegrationApi.md#track_event) | **POST** /v1/events | Track an Event
@@ -255,6 +256,71 @@ nil (empty response body)
255
256
 
256
257
 
257
258
 
259
+ # **get_customer_inventory**
260
+ > CustomerInventory get_customer_inventory(integration_id, opts)
261
+
262
+ Get an inventory of all data associated with a specific customer profile.
263
+
264
+ 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.
265
+
266
+ ### Example
267
+ ```ruby
268
+ # load the gem
269
+ require 'talon_one'
270
+ # setup authorization
271
+ TalonOne.configure do |config|
272
+ # Configure API key authorization: api_key_v1
273
+ config.api_key['Authorization'] = 'YOUR API KEY'
274
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
275
+ #config.api_key_prefix['Authorization'] = 'Bearer'
276
+
277
+ # Configure API key authorization: integration_auth
278
+ config.api_key['Content-Signature'] = 'YOUR API KEY'
279
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
280
+ #config.api_key_prefix['Content-Signature'] = 'Bearer'
281
+ end
282
+
283
+ api_instance = TalonOne::IntegrationApi.new
284
+
285
+ integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
286
+
287
+ opts = {
288
+ profile: nil, # Object | optional flag to decide if you would like customer profile information in the response
289
+ referrals: nil # Object | optional flag to decide if you would like referral information in the response
290
+ }
291
+
292
+ begin
293
+ #Get an inventory of all data associated with a specific customer profile.
294
+ result = api_instance.get_customer_inventory(integration_id, opts)
295
+ p result
296
+ rescue TalonOne::ApiError => e
297
+ puts "Exception when calling IntegrationApi->get_customer_inventory: #{e}"
298
+ end
299
+ ```
300
+
301
+ ### Parameters
302
+
303
+ Name | Type | Description | Notes
304
+ ------------- | ------------- | ------------- | -------------
305
+ **integration_id** | **String**| The custom identifier for this profile, must be unique within the account. |
306
+ **profile** | [**Object**](.md)| optional flag to decide if you would like customer profile information in the response | [optional]
307
+ **referrals** | [**Object**](.md)| optional flag to decide if you would like referral information in the response | [optional]
308
+
309
+ ### Return type
310
+
311
+ [**CustomerInventory**](CustomerInventory.md)
312
+
313
+ ### Authorization
314
+
315
+ [api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
316
+
317
+ ### HTTP request headers
318
+
319
+ - **Content-Type**: application/json
320
+ - **Accept**: application/json
321
+
322
+
323
+
258
324
  # **get_reserved_coupons**
259
325
  > InlineResponse2001 get_reserved_coupons(integration_id)
260
326
 
@@ -0,0 +1,10 @@
1
+ # TalonOne::IntegrationEvent
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **profile_id** | **String** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. | [optional]
7
+ **type** | **String** | A string representing the event. Must not be a reserved event name. |
8
+ **attributes** | **Object** | Arbitrary additional JSON data associated with the event. |
9
+
10
+
@@ -7,5 +7,6 @@ Name | Type | Description | Notes
7
7
  **profile** | [**CustomerProfile**](CustomerProfile.md) | |
8
8
  **event** | [**Event**](Event.md) | |
9
9
  **loyalty** | [**Loyalty**](Loyalty.md) | | [optional]
10
+ **coupon** | [**Coupon**](Coupon.md) | | [optional]
10
11
 
11
12
 
@@ -6,6 +6,7 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**add_loyalty_points**](ManagementApi.md#add_loyalty_points) | **PUT** /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points | Add points in a certain loyalty program for the specified customer
8
8
  [**copy_campaign_to_applications**](ManagementApi.md#copy_campaign_to_applications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into every specified application
9
+ [**create_attribute**](ManagementApi.md#create_attribute) | **POST** /v1/attributes | Define a new custom attribute
9
10
  [**create_campaign**](ManagementApi.md#create_campaign) | **POST** /v1/applications/{applicationId}/campaigns | Create a Campaign
10
11
  [**create_coupons**](ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create Coupons
11
12
  [**create_password_recovery_email**](ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
@@ -20,7 +21,6 @@ Method | HTTP request | Description
20
21
  [**get_access_logs_without_total_count**](ManagementApi.md#get_access_logs_without_total_count) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for application
21
22
  [**get_account**](ManagementApi.md#get_account) | **GET** /v1/accounts/{accountId} | Get Account Details
22
23
  [**get_account_analytics**](ManagementApi.md#get_account_analytics) | **GET** /v1/accounts/{accountId}/analytics | Get Account Analytics
23
- [**get_account_limits**](ManagementApi.md#get_account_limits) | **GET** /v1/accounts/{accountId}/limits | Get Account Limits
24
24
  [**get_all_access_logs**](ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | Get all access logs
25
25
  [**get_all_roles**](ManagementApi.md#get_all_roles) | **GET** /v1/roles | Get all roles.
26
26
  [**get_application**](ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application
@@ -35,6 +35,7 @@ Method | HTTP request | Description
35
35
  [**get_application_sessions**](ManagementApi.md#get_application_sessions) | **GET** /v1/applications/{applicationId}/sessions | List Application Sessions
36
36
  [**get_applications**](ManagementApi.md#get_applications) | **GET** /v1/applications | List Applications
37
37
  [**get_attribute**](ManagementApi.md#get_attribute) | **GET** /v1/attributes/{attributeId} | Get a custom attribute
38
+ [**get_attributes**](ManagementApi.md#get_attributes) | **GET** /v1/attributes | List custom attributes
38
39
  [**get_campaign**](ManagementApi.md#get_campaign) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId} | Get a Campaign
39
40
  [**get_campaign_analytics**](ManagementApi.md#get_campaign_analytics) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns
40
41
  [**get_campaign_by_attributes**](ManagementApi.md#get_campaign_by_attributes) | **POST** /v1/applications/{applicationId}/campaigns_search | Get a list of all campaigns that match the given attributes
@@ -76,7 +77,7 @@ Method | HTTP request | Description
76
77
  [**search_coupons_advanced_application_wide**](ManagementApi.md#search_coupons_advanced_application_wide) | **POST** /v1/applications/{applicationId}/coupons_search_advanced | Get a list of the coupons that match the given attributes in all active campaigns of an application
77
78
  [**search_coupons_advanced_application_wide_without_total_count**](ManagementApi.md#search_coupons_advanced_application_wide_without_total_count) | **POST** /v1/applications/{applicationId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes in all active campaigns of an application
78
79
  [**search_coupons_advanced_without_total_count**](ManagementApi.md#search_coupons_advanced_without_total_count) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes
79
- [**set_account_limits**](ManagementApi.md#set_account_limits) | **PUT** /v1/accounts/{accountId}/limits | Set account limits
80
+ [**update_attribute**](ManagementApi.md#update_attribute) | **PUT** /v1/attributes/{attributeId} | Update a custom attribute
80
81
  [**update_campaign**](ManagementApi.md#update_campaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update a Campaign
81
82
  [**update_campaign_set**](ManagementApi.md#update_campaign_set) | **PUT** /v1/applications/{applicationId}/campaign_set | Update a Campaign Set
82
83
  [**update_coupon**](ManagementApi.md#update_coupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon
@@ -203,6 +204,60 @@ Name | Type | Description | Notes
203
204
 
204
205
 
205
206
 
207
+ # **create_attribute**
208
+ > Attribute create_attribute(body)
209
+
210
+ Define a new custom attribute
211
+
212
+ 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.
213
+
214
+ ### Example
215
+ ```ruby
216
+ # load the gem
217
+ require 'talon_one'
218
+ # setup authorization
219
+ TalonOne.configure do |config|
220
+ # Configure API key authorization: manager_auth
221
+ config.api_key['Authorization'] = 'YOUR API KEY'
222
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
223
+ #config.api_key_prefix['Authorization'] = 'Bearer'
224
+ end
225
+
226
+ api_instance = TalonOne::ManagementApi.new
227
+
228
+ body = TalonOne::NewAttribute.new # NewAttribute |
229
+
230
+
231
+ begin
232
+ #Define a new custom attribute
233
+ result = api_instance.create_attribute(body)
234
+ p result
235
+ rescue TalonOne::ApiError => e
236
+ puts "Exception when calling ManagementApi->create_attribute: #{e}"
237
+ end
238
+ ```
239
+
240
+ ### Parameters
241
+
242
+ Name | Type | Description | Notes
243
+ ------------- | ------------- | ------------- | -------------
244
+ **body** | [**NewAttribute**](NewAttribute.md)| |
245
+
246
+ ### Return type
247
+
248
+ [**Attribute**](Attribute.md)
249
+
250
+ ### Authorization
251
+
252
+ [manager_auth](../README.md#manager_auth)
253
+
254
+ ### HTTP request headers
255
+
256
+ - **Content-Type**: application/json
257
+ - **Accept**: application/json
258
+
259
+
260
+
206
261
  # **create_campaign**
207
262
  > Campaign create_campaign(application_id, body)
208
263
 
@@ -265,7 +320,7 @@ Name | Type | Description | Notes
265
320
 
266
321
  Create Coupons
267
322
 
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 coupns can be created.
323
+ 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.
269
324
 
270
325
  ### Example
271
326
  ```ruby
@@ -837,8 +892,8 @@ range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only retu
837
892
  range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp, must be an RFC3339 timestamp string
838
893
 
839
894
  opts = {
840
- path: 'path_example', # String | Only return results where the request path matches the given regular expresssion.
841
- method: 'method_example', # String | Only return results where the request method matches the given regular expresssion.
895
+ path: 'path_example', # String | Only return results where the request path matches the given regular expression.
896
+ method: 'method_example', # String | Only return results where the request method matches the given regular expression.
842
897
  status: 'status_example', # String | Filter results by HTTP status codes.
843
898
  page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
844
899
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
@@ -861,8 +916,8 @@ Name | Type | Description | Notes
861
916
  **application_id** | **Integer**| |
862
917
  **range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
863
918
  **range_end** | **DateTime**| Only return results from before this timestamp, must be an RFC3339 timestamp string |
864
- **path** | **String**| Only return results where the request path matches the given regular expresssion. | [optional]
865
- **method** | **String**| Only return results where the request method matches the given regular expresssion. | [optional]
919
+ **path** | **String**| Only return results where the request path matches the given regular expression. | [optional]
920
+ **method** | **String**| Only return results where the request method matches the given regular expression. | [optional]
866
921
  **status** | **String**| Filter results by HTTP status codes. | [optional]
867
922
  **page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
868
923
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
@@ -911,8 +966,8 @@ range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only retu
911
966
  range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp, must be an RFC3339 timestamp string
912
967
 
913
968
  opts = {
914
- path: 'path_example', # String | Only return results where the request path matches the given regular expresssion.
915
- method: 'method_example', # String | Only return results where the request method matches the given regular expresssion.
969
+ path: 'path_example', # String | Only return results where the request path matches the given regular expression.
970
+ method: 'method_example', # String | Only return results where the request method matches the given regular expression.
916
971
  status: 'status_example', # String | Filter results by HTTP status codes.
917
972
  page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
918
973
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
@@ -935,8 +990,8 @@ Name | Type | Description | Notes
935
990
  **application_id** | **Integer**| |
936
991
  **range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
937
992
  **range_end** | **DateTime**| Only return results from before this timestamp, must be an RFC3339 timestamp string |
938
- **path** | **String**| Only return results where the request path matches the given regular expresssion. | [optional]
939
- **method** | **String**| Only return results where the request method matches the given regular expresssion. | [optional]
993
+ **path** | **String**| Only return results where the request path matches the given regular expression. | [optional]
994
+ **method** | **String**| Only return results where the request method matches the given regular expression. | [optional]
940
995
  **status** | **String**| Filter results by HTTP status codes. | [optional]
941
996
  **page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
942
997
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
@@ -1065,60 +1120,6 @@ Name | Type | Description | Notes
1065
1120
 
1066
1121
 
1067
1122
 
1068
- # **get_account_limits**
1069
- > AccountLimits get_account_limits(account_id)
1070
-
1071
- Get Account Limits
1072
-
1073
- Returns a list of all account limits set
1074
-
1075
- ### Example
1076
- ```ruby
1077
- # load the gem
1078
- require 'talon_one'
1079
- # setup authorization
1080
- TalonOne.configure do |config|
1081
- # Configure API key authorization: manager_auth
1082
- config.api_key['Authorization'] = 'YOUR API KEY'
1083
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1084
- #config.api_key_prefix['Authorization'] = 'Bearer'
1085
- end
1086
-
1087
- api_instance = TalonOne::ManagementApi.new
1088
-
1089
- account_id = 56 # Integer |
1090
-
1091
-
1092
- begin
1093
- #Get Account Limits
1094
- result = api_instance.get_account_limits(account_id)
1095
- p result
1096
- rescue TalonOne::ApiError => e
1097
- puts "Exception when calling ManagementApi->get_account_limits: #{e}"
1098
- end
1099
- ```
1100
-
1101
- ### Parameters
1102
-
1103
- Name | Type | Description | Notes
1104
- ------------- | ------------- | ------------- | -------------
1105
- **account_id** | **Integer**| |
1106
-
1107
- ### Return type
1108
-
1109
- [**AccountLimits**](AccountLimits.md)
1110
-
1111
- ### Authorization
1112
-
1113
- [manager_auth](../README.md#manager_auth)
1114
-
1115
- ### HTTP request headers
1116
-
1117
- - **Content-Type**: application/json
1118
- - **Accept**: application/json
1119
-
1120
-
1121
-
1122
1123
  # **get_all_access_logs**
1123
1124
  > InlineResponse2009 get_all_access_logs(range_start, range_end, opts)
1124
1125
 
@@ -1145,8 +1146,8 @@ range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only retu
1145
1146
  range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp, must be an RFC3339 timestamp string
1146
1147
 
1147
1148
  opts = {
1148
- path: 'path_example', # String | Only return results where the request path matches the given regular expresssion.
1149
- method: 'method_example', # String | Only return results where the request method matches the given regular expresssion.
1149
+ path: 'path_example', # String | Only return results where the request path matches the given regular expression.
1150
+ method: 'method_example', # String | Only return results where the request method matches the given regular expression.
1150
1151
  status: 'status_example', # String | Filter results by HTTP status codes.
1151
1152
  page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
1152
1153
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
@@ -1168,8 +1169,8 @@ Name | Type | Description | Notes
1168
1169
  ------------- | ------------- | ------------- | -------------
1169
1170
  **range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
1170
1171
  **range_end** | **DateTime**| Only return results from before this timestamp, must be an RFC3339 timestamp string |
1171
- **path** | **String**| Only return results where the request path matches the given regular expresssion. | [optional]
1172
- **method** | **String**| Only return results where the request method matches the given regular expresssion. | [optional]
1172
+ **path** | **String**| Only return results where the request path matches the given regular expression. | [optional]
1173
+ **method** | **String**| Only return results where the request method matches the given regular expression. | [optional]
1173
1174
  **status** | **String**| Filter results by HTTP status codes. | [optional]
1174
1175
  **page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
1175
1176
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
@@ -1191,7 +1192,7 @@ Name | Type | Description | Notes
1191
1192
 
1192
1193
 
1193
1194
  # **get_all_roles**
1194
- > InlineResponse20028 get_all_roles
1195
+ > InlineResponse20029 get_all_roles
1195
1196
 
1196
1197
  Get all roles.
1197
1198
 
@@ -1223,7 +1224,7 @@ This endpoint does not need any parameter.
1223
1224
 
1224
1225
  ### Return type
1225
1226
 
1226
- [**InlineResponse20028**](InlineResponse20028.md)
1227
+ [**InlineResponse20029**](InlineResponse20029.md)
1227
1228
 
1228
1229
  ### Authorization
1229
1230
 
@@ -1460,7 +1461,7 @@ Name | Type | Description | Notes
1460
1461
 
1461
1462
  Get a list of the customer profiles that match the given attributes
1462
1463
 
1463
- 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]: http://help.talon.one/customer/en/portal/articles/2525263-data-model?b_id=14115#customer-profile
1464
+ 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
1464
1465
 
1465
1466
  ### Example
1466
1467
  ```ruby
@@ -1977,6 +1978,65 @@ Name | Type | Description | Notes
1977
1978
 
1978
1979
 
1979
1980
 
1981
+ # **get_attributes**
1982
+ > InlineResponse20020 get_attributes(opts)
1983
+
1984
+ List custom attributes
1985
+
1986
+ Returns all the defined custom attributes for the account.
1987
+
1988
+ ### Example
1989
+ ```ruby
1990
+ # load the gem
1991
+ require 'talon_one'
1992
+ # setup authorization
1993
+ TalonOne.configure do |config|
1994
+ # Configure API key authorization: manager_auth
1995
+ config.api_key['Authorization'] = 'YOUR API KEY'
1996
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1997
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1998
+ end
1999
+
2000
+ api_instance = TalonOne::ManagementApi.new
2001
+
2002
+ opts = {
2003
+ page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
2004
+ skip: 56, # Integer | Skips the given number of items when paging through large result sets.
2005
+ sort: 'sort_example' # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
2006
+ }
2007
+
2008
+ begin
2009
+ #List custom attributes
2010
+ result = api_instance.get_attributes(opts)
2011
+ p result
2012
+ rescue TalonOne::ApiError => e
2013
+ puts "Exception when calling ManagementApi->get_attributes: #{e}"
2014
+ end
2015
+ ```
2016
+
2017
+ ### Parameters
2018
+
2019
+ Name | Type | Description | Notes
2020
+ ------------- | ------------- | ------------- | -------------
2021
+ **page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
2022
+ **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
2023
+ **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
2024
+
2025
+ ### Return type
2026
+
2027
+ [**InlineResponse20020**](InlineResponse20020.md)
2028
+
2029
+ ### Authorization
2030
+
2031
+ [manager_auth](../README.md#manager_auth)
2032
+
2033
+ ### HTTP request headers
2034
+
2035
+ - **Content-Type**: application/json
2036
+ - **Accept**: application/json
2037
+
2038
+
2039
+
1980
2040
  # **get_campaign**
1981
2041
  > Campaign get_campaign(application_id, campaign_id)
1982
2042
 
@@ -2055,7 +2115,7 @@ end
2055
2115
 
2056
2116
  api_instance = TalonOne::ManagementApi.new
2057
2117
 
2058
- application_id = 56 # Integer | The identifier for the application
2118
+ application_id = 56 # Integer |
2059
2119
 
2060
2120
  campaign_id = 56 # Integer |
2061
2121
 
@@ -2080,7 +2140,7 @@ end
2080
2140
 
2081
2141
  Name | Type | Description | Notes
2082
2142
  ------------- | ------------- | ------------- | -------------
2083
- **application_id** | **Integer**| The identifier for the application |
2143
+ **application_id** | **Integer**| |
2084
2144
  **campaign_id** | **Integer**| |
2085
2145
  **range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
2086
2146
  **range_end** | **DateTime**| Only return results from before this timestamp, must be an RFC3339 timestamp string |
@@ -2295,7 +2355,7 @@ Name | Type | Description | Notes
2295
2355
 
2296
2356
 
2297
2357
  # **get_changes**
2298
- > InlineResponse20025 get_changes(opts)
2358
+ > InlineResponse20026 get_changes(opts)
2299
2359
 
2300
2360
  Get audit log for an account
2301
2361
 
@@ -2318,7 +2378,12 @@ api_instance = TalonOne::ManagementApi.new
2318
2378
  opts = {
2319
2379
  page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
2320
2380
  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
2321
- sort: 'sort_example' # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
2381
+ sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
2382
+ application_id: 56, # Integer |
2383
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
2384
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
2385
+ with_total_result_size: true, # BOOLEAN | 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.
2386
+ include_old: true # BOOLEAN | When this flag is set to false, the state without the change will not be returned. The default value is true.
2322
2387
  }
2323
2388
 
2324
2389
  begin
@@ -2337,10 +2402,15 @@ Name | Type | Description | Notes
2337
2402
  **page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
2338
2403
  **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
2339
2404
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
2405
+ **application_id** | **Integer**| | [optional]
2406
+ **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. | [optional]
2407
+ **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. | [optional]
2408
+ **with_total_result_size** | **BOOLEAN**| 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. | [optional]
2409
+ **include_old** | **BOOLEAN**| When this flag is set to false, the state without the change will not be returned. The default value is true. | [optional]
2340
2410
 
2341
2411
  ### Return type
2342
2412
 
2343
- [**InlineResponse20025**](InlineResponse20025.md)
2413
+ [**InlineResponse20026**](InlineResponse20026.md)
2344
2414
 
2345
2415
  ### Authorization
2346
2416
 
@@ -3103,7 +3173,7 @@ Name | Type | Description | Notes
3103
3173
 
3104
3174
  Get a list of the customer profiles that match the given attributes
3105
3175
 
3106
- 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]: http://help.talon.one/customer/en/portal/articles/2525263-data-model?b_id=14115#customer-profile
3176
+ 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
3107
3177
 
3108
3178
  ### Example
3109
3179
  ```ruby
@@ -3159,7 +3229,7 @@ Name | Type | Description | Notes
3159
3229
 
3160
3230
 
3161
3231
  # **get_event_types**
3162
- > InlineResponse20023 get_event_types(opts)
3232
+ > InlineResponse20024 get_event_types(opts)
3163
3233
 
3164
3234
  List Event Types
3165
3235
 
@@ -3210,7 +3280,7 @@ Name | Type | Description | Notes
3210
3280
 
3211
3281
  ### Return type
3212
3282
 
3213
- [**InlineResponse20023**](InlineResponse20023.md)
3283
+ [**InlineResponse20024**](InlineResponse20024.md)
3214
3284
 
3215
3285
  ### Authorization
3216
3286
 
@@ -3224,7 +3294,7 @@ Name | Type | Description | Notes
3224
3294
 
3225
3295
 
3226
3296
  # **get_exports**
3227
- > InlineResponse20026 get_exports(opts)
3297
+ > InlineResponse20027 get_exports(opts)
3228
3298
 
3229
3299
  Get Exports
3230
3300
 
@@ -3273,7 +3343,7 @@ Name | Type | Description | Notes
3273
3343
 
3274
3344
  ### Return type
3275
3345
 
3276
- [**InlineResponse20026**](InlineResponse20026.md)
3346
+ [**InlineResponse20027**](InlineResponse20027.md)
3277
3347
 
3278
3348
  ### Authorization
3279
3349
 
@@ -3287,7 +3357,7 @@ Name | Type | Description | Notes
3287
3357
 
3288
3358
 
3289
3359
  # **get_imports**
3290
- > InlineResponse20027 get_imports(opts)
3360
+ > InlineResponse20028 get_imports(opts)
3291
3361
 
3292
3362
  Get Imports
3293
3363
 
@@ -3330,7 +3400,7 @@ Name | Type | Description | Notes
3330
3400
 
3331
3401
  ### Return type
3332
3402
 
3333
- [**InlineResponse20027**](InlineResponse20027.md)
3403
+ [**InlineResponse20028**](InlineResponse20028.md)
3334
3404
 
3335
3405
  ### Authorization
3336
3406
 
@@ -3888,7 +3958,7 @@ Name | Type | Description | Notes
3888
3958
 
3889
3959
 
3890
3960
  # **get_users**
3891
- > InlineResponse20024 get_users(opts)
3961
+ > InlineResponse20025 get_users(opts)
3892
3962
 
3893
3963
  List Users in your account
3894
3964
 
@@ -3933,7 +4003,7 @@ Name | Type | Description | Notes
3933
4003
 
3934
4004
  ### Return type
3935
4005
 
3936
- [**InlineResponse20024**](InlineResponse20024.md)
4006
+ [**InlineResponse20025**](InlineResponse20025.md)
3937
4007
 
3938
4008
  ### Authorization
3939
4009
 
@@ -4001,7 +4071,7 @@ Name | Type | Description | Notes
4001
4071
 
4002
4072
 
4003
4073
  # **get_webhook_activation_logs**
4004
- > InlineResponse20021 get_webhook_activation_logs(opts)
4074
+ > InlineResponse20022 get_webhook_activation_logs(opts)
4005
4075
 
4006
4076
  List Webhook activation Log Entries
4007
4077
 
@@ -4058,7 +4128,7 @@ Name | Type | Description | Notes
4058
4128
 
4059
4129
  ### Return type
4060
4130
 
4061
- [**InlineResponse20021**](InlineResponse20021.md)
4131
+ [**InlineResponse20022**](InlineResponse20022.md)
4062
4132
 
4063
4133
  ### Authorization
4064
4134
 
@@ -4072,7 +4142,7 @@ Name | Type | Description | Notes
4072
4142
 
4073
4143
 
4074
4144
  # **get_webhook_logs**
4075
- > InlineResponse20022 get_webhook_logs(opts)
4145
+ > InlineResponse20023 get_webhook_logs(opts)
4076
4146
 
4077
4147
  List Webhook Log Entries
4078
4148
 
@@ -4131,7 +4201,7 @@ Name | Type | Description | Notes
4131
4201
 
4132
4202
  ### Return type
4133
4203
 
4134
- [**InlineResponse20022**](InlineResponse20022.md)
4204
+ [**InlineResponse20023**](InlineResponse20023.md)
4135
4205
 
4136
4206
  ### Authorization
4137
4207
 
@@ -4145,7 +4215,7 @@ Name | Type | Description | Notes
4145
4215
 
4146
4216
 
4147
4217
  # **get_webhooks**
4148
- > InlineResponse20020 get_webhooks(opts)
4218
+ > InlineResponse20021 get_webhooks(opts)
4149
4219
 
4150
4220
  List Webhooks
4151
4221
 
@@ -4192,7 +4262,7 @@ Name | Type | Description | Notes
4192
4262
 
4193
4263
  ### Return type
4194
4264
 
4195
- [**InlineResponse20020**](InlineResponse20020.md)
4265
+ [**InlineResponse20021**](InlineResponse20021.md)
4196
4266
 
4197
4267
  ### Authorization
4198
4268
 
@@ -4707,12 +4777,12 @@ Name | Type | Description | Notes
4707
4777
 
4708
4778
 
4709
4779
 
4710
- # **set_account_limits**
4711
- > set_account_limits(account_id, body)
4780
+ # **update_attribute**
4781
+ > Attribute update_attribute(attribute_id, body)
4712
4782
 
4713
- Set account limits
4783
+ Update a custom attribute
4714
4784
 
4715
- sets account limits
4785
+ 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.
4716
4786
 
4717
4787
  ### Example
4718
4788
  ```ruby
@@ -4728,16 +4798,17 @@ end
4728
4798
 
4729
4799
  api_instance = TalonOne::ManagementApi.new
4730
4800
 
4731
- account_id = 56 # Integer |
4801
+ attribute_id = 56 # Integer |
4732
4802
 
4733
- body = TalonOne::AccountLimits.new # AccountLimits |
4803
+ body = TalonOne::NewAttribute.new # NewAttribute |
4734
4804
 
4735
4805
 
4736
4806
  begin
4737
- #Set account limits
4738
- api_instance.set_account_limits(account_id, body)
4807
+ #Update a custom attribute
4808
+ result = api_instance.update_attribute(attribute_id, body)
4809
+ p result
4739
4810
  rescue TalonOne::ApiError => e
4740
- puts "Exception when calling ManagementApi->set_account_limits: #{e}"
4811
+ puts "Exception when calling ManagementApi->update_attribute: #{e}"
4741
4812
  end
4742
4813
  ```
4743
4814
 
@@ -4745,12 +4816,12 @@ end
4745
4816
 
4746
4817
  Name | Type | Description | Notes
4747
4818
  ------------- | ------------- | ------------- | -------------
4748
- **account_id** | **Integer**| |
4749
- **body** | [**AccountLimits**](AccountLimits.md)| |
4819
+ **attribute_id** | **Integer**| |
4820
+ **body** | [**NewAttribute**](NewAttribute.md)| |
4750
4821
 
4751
4822
  ### Return type
4752
4823
 
4753
- nil (empty response body)
4824
+ [**Attribute**](Attribute.md)
4754
4825
 
4755
4826
  ### Authorization
4756
4827