talon_one 8.0.0 → 9.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -8
  3. data/docs/AchievementBase.md +35 -0
  4. data/docs/AchievementProgressWithDefinition.md +45 -0
  5. data/docs/AchievementStatusEntry.md +45 -0
  6. data/docs/AnalyticsSKU.md +23 -0
  7. data/docs/ApplicationCIFReferences.md +19 -0
  8. data/docs/CampaignDetail.md +19 -0
  9. data/docs/CampaignStoreBudgetLimitConfig.md +25 -0
  10. data/docs/CampaignTemplate.md +3 -1
  11. data/docs/HiddenConditionsEffects.md +23 -0
  12. data/docs/InlineResponse20048.md +19 -0
  13. data/docs/InlineResponse20049.md +19 -0
  14. data/docs/IntegrationApi.md +3 -1
  15. data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
  16. data/docs/LoyaltyLedgerEntryFlags.md +17 -0
  17. data/docs/LoyaltyProgramTransaction.md +3 -1
  18. data/docs/ManagementApi.md +164 -323
  19. data/docs/MessageTest.md +27 -0
  20. data/docs/NewMessageTest.md +29 -0
  21. data/docs/ProductUnitAnalyticsDataPoint.md +25 -0
  22. data/docs/ProductUnitAnalyticsTotals.md +17 -0
  23. data/docs/SkuUnitAnalytics.md +19 -0
  24. data/docs/SkuUnitAnalyticsDataPoint.md +23 -0
  25. data/docs/StrikethroughLabelingNotification.md +2 -0
  26. data/lib/talon_one/api/integration_api.rb +3 -0
  27. data/lib/talon_one/api/management_api.rb +191 -354
  28. data/lib/talon_one/models/achievement_base.rb +377 -0
  29. data/lib/talon_one/models/achievement_progress_with_definition.rb +490 -0
  30. data/lib/talon_one/models/achievement_status_entry.rb +472 -0
  31. data/lib/talon_one/models/analytics_sku.rb +246 -0
  32. data/lib/talon_one/models/application_cif_references.rb +219 -0
  33. data/lib/talon_one/models/campaign_detail.rb +232 -0
  34. data/lib/talon_one/models/campaign_store_budget_limit_config.rb +322 -0
  35. data/lib/talon_one/models/campaign_template.rb +16 -4
  36. data/lib/talon_one/models/delete_user_request.rb +0 -1
  37. data/lib/talon_one/models/hidden_conditions_effects.rb +246 -0
  38. data/lib/talon_one/models/inline_response20048.rb +222 -0
  39. data/lib/talon_one/models/inline_response20049.rb +227 -0
  40. data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +13 -4
  41. data/lib/talon_one/models/loyalty_ledger_entry_flags.rb +208 -0
  42. data/lib/talon_one/models/loyalty_program_transaction.rb +13 -4
  43. data/lib/talon_one/models/message_test.rb +227 -0
  44. data/lib/talon_one/models/new_message_test.rb +322 -0
  45. data/lib/talon_one/models/product_unit_analytics_data_point.rb +271 -0
  46. data/lib/talon_one/models/product_unit_analytics_totals.rb +206 -0
  47. data/lib/talon_one/models/sku_unit_analytics.rb +227 -0
  48. data/lib/talon_one/models/sku_unit_analytics_data_point.rb +256 -0
  49. data/lib/talon_one/models/strikethrough_labeling_notification.rb +11 -1
  50. data/lib/talon_one/version.rb +1 -1
  51. data/lib/talon_one.rb +2 -1
  52. data/spec/api/integration_api_spec.rb +1 -0
  53. data/spec/api/management_api_spec.rb +60 -87
  54. data/spec/models/campaign_template_spec.rb +6 -0
  55. data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
  56. data/spec/models/loyalty_program_transaction_spec.rb +6 -0
  57. data/spec/models/revision_activation_request_spec.rb +47 -0
  58. data/spec/models/strikethrough_labeling_notification_spec.rb +6 -0
  59. metadata +563 -527
@@ -108,6 +108,7 @@ Method | HTTP request | Description
108
108
  [**get_loyalty_program_transactions**](ManagementApi.md#get_loyalty_program_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/transactions | List loyalty program transactions
109
109
  [**get_loyalty_programs**](ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List loyalty programs
110
110
  [**get_loyalty_statistics**](ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics
111
+ [**get_message_logs**](ManagementApi.md#get_message_logs) | **GET** /v1/message_logs | List message log entries
111
112
  [**get_referrals_without_total_count**](ManagementApi.md#get_referrals_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List referrals
112
113
  [**get_role_v2**](ManagementApi.md#get_role_v2) | **GET** /v2/roles/{roleId} | Get role
113
114
  [**get_ruleset**](ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset
@@ -138,11 +139,7 @@ Method | HTTP request | Description
138
139
  [**list_collections**](ManagementApi.md#list_collections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign
139
140
  [**list_collections_in_application**](ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
140
141
  [**list_stores**](ManagementApi.md#list_stores) | **GET** /v1/applications/{applicationId}/stores | List stores
141
- [**notification_activation**](ManagementApi.md#notification_activation) | **PUT** /v1/notifications/{notificationId}/activation | Activate or deactivate notification
142
142
  [**okta_event_handler_challenge**](ManagementApi.md#okta_event_handler_challenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
143
- [**post_added_deducted_points_notification**](ManagementApi.md#post_added_deducted_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points
144
- [**post_catalogs_strikethrough_notification**](ManagementApi.md#post_catalogs_strikethrough_notification) | **POST** /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification
145
- [**post_pending_points_notification**](ManagementApi.md#post_pending_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points | Create notification about pending loyalty points
146
143
  [**remove_loyalty_points**](ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile
147
144
  [**reset_password**](ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
148
145
  [**scim_create_user**](ManagementApi.md#scim_create_user) | **POST** /v1/provisioning/scim/Users | Create SCIM user
@@ -200,7 +197,7 @@ TalonOne.configure do |config|
200
197
  end
201
198
 
202
199
  api_instance = TalonOne::ManagementApi.new
203
- body = TalonOne::DeactivateUserRequest.new # DeactivateUserRequest | body
200
+ body = TalonOne::DeleteUserRequest.new # DeleteUserRequest | body
204
201
 
205
202
  begin
206
203
  #Enable user by email address
@@ -215,7 +212,7 @@ end
215
212
 
216
213
  Name | Type | Description | Notes
217
214
  ------------- | ------------- | ------------- | -------------
218
- **body** | **DeactivateUserRequest**| body |
215
+ **body** | **DeleteUserRequest**| body |
219
216
 
220
217
  ### Return type
221
218
 
@@ -1427,7 +1424,7 @@ TalonOne.configure do |config|
1427
1424
  end
1428
1425
 
1429
1426
  api_instance = TalonOne::ManagementApi.new
1430
- body = TalonOne::DeactivateUserRequest.new # DeactivateUserRequest | body
1427
+ body = TalonOne::DeleteUserRequest.new # DeleteUserRequest | body
1431
1428
 
1432
1429
  begin
1433
1430
  #Disable user by email address
@@ -1442,7 +1439,7 @@ end
1442
1439
 
1443
1440
  Name | Type | Description | Notes
1444
1441
  ------------- | ------------- | ------------- | -------------
1445
- **body** | [**DeactivateUserRequest**](DeactivateUserRequest.md)| body |
1442
+ **body** | **DeleteUserRequest**| body |
1446
1443
 
1447
1444
  ### Return type
1448
1445
 
@@ -2179,7 +2176,7 @@ TalonOne.configure do |config|
2179
2176
  end
2180
2177
 
2181
2178
  api_instance = TalonOne::ManagementApi.new
2182
- body = TalonOne::DeactivateUserRequest.new # DeactivateUserRequest | body
2179
+ body = TalonOne::DeleteUserRequest.new # DeleteUserRequest | body
2183
2180
 
2184
2181
  begin
2185
2182
  #Delete user by email address
@@ -2194,7 +2191,7 @@ end
2194
2191
 
2195
2192
  Name | Type | Description | Notes
2196
2193
  ------------- | ------------- | ------------- | -------------
2197
- **body** | **DeactivateUserRequest**| body |
2194
+ **body** | [**DeleteUserRequest**](DeleteUserRequest.md)| body |
2198
2195
 
2199
2196
  ### Return type
2200
2197
 
@@ -2659,7 +2656,7 @@ api_instance = TalonOne::ManagementApi.new
2659
2656
  application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
2660
2657
  opts = {
2661
2658
  campaign_id: 3.4, # Float | Filter results by campaign ID.
2662
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
2659
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
2663
2660
  value: 'value_example', # String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
2664
2661
  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 coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
2665
2662
  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 coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -2690,7 +2687,7 @@ Name | Type | Description | Notes
2690
2687
  ------------- | ------------- | ------------- | -------------
2691
2688
  **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
2692
2689
  **campaign_id** | **Float**| Filter results by campaign ID. | [optional]
2693
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
2690
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
2694
2691
  **value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
2695
2692
  **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
2696
2693
  **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
@@ -3252,7 +3249,7 @@ Name | Type | Description | Notes
3252
3249
 
3253
3250
  Export customer's transaction logs
3254
3251
 
3255
- Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign.
3252
+ Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance.
3256
3253
 
3257
3254
  ### Example
3258
3255
 
@@ -3491,7 +3488,7 @@ opts = {
3491
3488
  status: 'status_example', # String | Filter results by HTTP status codes.
3492
3489
  page_size: 1000, # Integer | The number of items in the response.
3493
3490
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
3494
- sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
3491
+ sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
3495
3492
  }
3496
3493
 
3497
3494
  begin
@@ -3516,7 +3513,7 @@ Name | Type | Description | Notes
3516
3513
  **status** | **String**| Filter results by HTTP status codes. | [optional]
3517
3514
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
3518
3515
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
3519
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
3516
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
3520
3517
 
3521
3518
  ### Return type
3522
3519
 
@@ -3861,7 +3858,7 @@ api_instance = TalonOne::ManagementApi.new
3861
3858
  opts = {
3862
3859
  page_size: 1000, # Integer | The number of items in the response.
3863
3860
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
3864
- sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
3861
+ sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
3865
3862
  }
3866
3863
 
3867
3864
  begin
@@ -3880,7 +3877,7 @@ Name | Type | Description | Notes
3880
3877
  ------------- | ------------- | ------------- | -------------
3881
3878
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
3882
3879
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
3883
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
3880
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
3884
3881
 
3885
3882
  ### Return type
3886
3883
 
@@ -4107,7 +4104,7 @@ integration_id = 'integration_id_example' # String | The Integration ID of the A
4107
4104
  opts = {
4108
4105
  page_size: 1000, # Integer | The number of items in the response.
4109
4106
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
4110
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
4107
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4111
4108
  with_total_result_size: true # Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
4112
4109
  }
4113
4110
 
@@ -4129,7 +4126,7 @@ Name | Type | Description | Notes
4129
4126
  **integration_id** | **String**| The Integration ID of the Advocate's Profile. |
4130
4127
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
4131
4128
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
4132
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
4129
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
4133
4130
  **with_total_result_size** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
4134
4131
 
4135
4132
  ### Return type
@@ -4315,7 +4312,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
4315
4312
  opts = {
4316
4313
  page_size: 1000, # Integer | The number of items in the response.
4317
4314
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
4318
- sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
4315
+ sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4319
4316
  }
4320
4317
 
4321
4318
  begin
@@ -4335,7 +4332,7 @@ Name | Type | Description | Notes
4335
4332
  **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
4336
4333
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
4337
4334
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
4338
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
4335
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
4339
4336
 
4340
4337
  ### Return type
4341
4338
 
@@ -4382,7 +4379,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
4382
4379
  opts = {
4383
4380
  page_size: 1000, # Integer | The number of items in the response.
4384
4381
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
4385
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
4382
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4386
4383
  type: 'type_example', # String | Comma-separated list of types by which to filter events. Must be exact match(es).
4387
4384
  created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
4388
4385
  created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -4413,7 +4410,7 @@ Name | Type | Description | Notes
4413
4410
  **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
4414
4411
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
4415
4412
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
4416
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
4413
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
4417
4414
  **type** | **String**| Comma-separated list of types by which to filter events. Must be exact match(es). | [optional]
4418
4415
  **created_before** | **DateTime**| Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
4419
4416
  **created_after** | **DateTime**| Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
@@ -4532,7 +4529,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
4532
4529
  opts = {
4533
4530
  page_size: 1000, # Integer | The number of items in the response.
4534
4531
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
4535
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
4532
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4536
4533
  profile: 'profile_example', # String | Profile integration ID filter for sessions. Must be exact match.
4537
4534
  state: 'state_example', # String | Filter by sessions with this state. Must be exact match.
4538
4535
  created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -4560,7 +4557,7 @@ Name | Type | Description | Notes
4560
4557
  **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
4561
4558
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
4562
4559
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
4563
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
4560
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
4564
4561
  **profile** | **String**| Profile integration ID filter for sessions. Must be exact match. | [optional]
4565
4562
  **state** | **String**| Filter by sessions with this state. Must be exact match. | [optional]
4566
4563
  **created_before** | **DateTime**| Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
@@ -4614,7 +4611,7 @@ api_instance = TalonOne::ManagementApi.new
4614
4611
  opts = {
4615
4612
  page_size: 1000, # Integer | The number of items in the response.
4616
4613
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
4617
- sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
4614
+ sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4618
4615
  }
4619
4616
 
4620
4617
  begin
@@ -4633,7 +4630,7 @@ Name | Type | Description | Notes
4633
4630
  ------------- | ------------- | ------------- | -------------
4634
4631
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
4635
4632
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
4636
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
4633
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
4637
4634
 
4638
4635
  ### Return type
4639
4636
 
@@ -4738,7 +4735,7 @@ api_instance = TalonOne::ManagementApi.new
4738
4735
  opts = {
4739
4736
  page_size: 1000, # Integer | The number of items in the response.
4740
4737
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
4741
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
4738
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4742
4739
  entity: 'entity_example' # String | Returned attributes will be filtered by supplied entity.
4743
4740
  }
4744
4741
 
@@ -4758,7 +4755,7 @@ Name | Type | Description | Notes
4758
4755
  ------------- | ------------- | ------------- | -------------
4759
4756
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
4760
4757
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
4761
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
4758
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
4762
4759
  **entity** | **String**| Returned attributes will be filtered by supplied entity. | [optional]
4763
4760
 
4764
4761
  ### Return type
@@ -4806,7 +4803,7 @@ audience_id = 56 # Integer | The ID of the audience.
4806
4803
  opts = {
4807
4804
  page_size: 1000, # Integer | The number of items in the response.
4808
4805
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
4809
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
4806
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4810
4807
  profile_query: 'profile_query_example' # String | The filter to select a profile.
4811
4808
  }
4812
4809
 
@@ -4827,7 +4824,7 @@ Name | Type | Description | Notes
4827
4824
  **audience_id** | **Integer**| The ID of the audience. |
4828
4825
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
4829
4826
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
4830
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
4827
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
4831
4828
  **profile_query** | **String**| The filter to select a profile. | [optional]
4832
4829
 
4833
4830
  ### Return type
@@ -4874,7 +4871,7 @@ api_instance = TalonOne::ManagementApi.new
4874
4871
  opts = {
4875
4872
  page_size: 1000, # Integer | The number of items in the response.
4876
4873
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
4877
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
4874
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4878
4875
  with_total_result_size: true # Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
4879
4876
  }
4880
4877
 
@@ -4894,7 +4891,7 @@ Name | Type | Description | Notes
4894
4891
  ------------- | ------------- | ------------- | -------------
4895
4892
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
4896
4893
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
4897
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
4894
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
4898
4895
  **with_total_result_size** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
4899
4896
 
4900
4897
  ### Return type
@@ -4940,7 +4937,7 @@ end
4940
4937
  api_instance = TalonOne::ManagementApi.new
4941
4938
  audience_ids = 'audience_ids_example' # String | The IDs of one or more audiences, separated by commas, by which to filter results.
4942
4939
  opts = {
4943
- sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
4940
+ sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
4944
4941
  }
4945
4942
 
4946
4943
  begin
@@ -4958,7 +4955,7 @@ end
4958
4955
  Name | Type | Description | Notes
4959
4956
  ------------- | ------------- | ------------- | -------------
4960
4957
  **audience_ids** | **String**| The IDs of one or more audiences, separated by commas, by which to filter results. |
4961
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
4958
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
4962
4959
 
4963
4960
  ### Return type
4964
4961
 
@@ -5136,7 +5133,7 @@ body = TalonOne::CampaignSearch.new # CampaignSearch | body
5136
5133
  opts = {
5137
5134
  page_size: 1000, # Integer | The number of items in the response.
5138
5135
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
5139
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
5136
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5140
5137
  campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
5141
5138
  }
5142
5139
 
@@ -5158,7 +5155,7 @@ Name | Type | Description | Notes
5158
5155
  **body** | [**CampaignSearch**](CampaignSearch.md)| body |
5159
5156
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
5160
5157
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
5161
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
5158
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
5162
5159
  **campaign_state** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. | [optional]
5163
5160
 
5164
5161
  ### Return type
@@ -5264,7 +5261,7 @@ api_instance = TalonOne::ManagementApi.new
5264
5261
  opts = {
5265
5262
  page_size: 1000, # Integer | The number of items in the response.
5266
5263
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
5267
- sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
5264
+ sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5268
5265
  }
5269
5266
 
5270
5267
  begin
@@ -5283,7 +5280,7 @@ Name | Type | Description | Notes
5283
5280
  ------------- | ------------- | ------------- | -------------
5284
5281
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
5285
5282
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
5286
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
5283
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
5287
5284
 
5288
5285
  ### Return type
5289
5286
 
@@ -5329,7 +5326,7 @@ api_instance = TalonOne::ManagementApi.new
5329
5326
  opts = {
5330
5327
  page_size: 1000, # Integer | The number of items in the response.
5331
5328
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
5332
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
5329
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5333
5330
  state: 'state_example', # String | Filter results by the state of the campaign template.
5334
5331
  name: 'name_example', # String | Filter results performing case-insensitive matching against the name of the campaign template.
5335
5332
  tags: 'tags_example', # String | Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values.
@@ -5352,7 +5349,7 @@ Name | Type | Description | Notes
5352
5349
  ------------- | ------------- | ------------- | -------------
5353
5350
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
5354
5351
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
5355
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
5352
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
5356
5353
  **state** | **String**| Filter results by the state of the campaign template. | [optional]
5357
5354
  **name** | **String**| Filter results performing case-insensitive matching against the name of the campaign template. | [optional]
5358
5355
  **tags** | **String**| Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values. | [optional]
@@ -5403,7 +5400,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
5403
5400
  opts = {
5404
5401
  page_size: 1000, # Integer | The number of items in the response.
5405
5402
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
5406
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
5403
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5407
5404
  campaign_state: 'campaign_state_example', # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
5408
5405
  name: 'name_example', # String | Filter results performing case-insensitive matching against the name of the campaign.
5409
5406
  tags: 'tags_example', # String | Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
@@ -5431,7 +5428,7 @@ Name | Type | Description | Notes
5431
5428
  **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
5432
5429
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
5433
5430
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
5434
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
5431
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
5435
5432
  **campaign_state** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. | [optional]
5436
5433
  **name** | **String**| Filter results performing case-insensitive matching against the name of the campaign. | [optional]
5437
5434
  **tags** | **String**| Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values | [optional]
@@ -5485,7 +5482,7 @@ api_instance = TalonOne::ManagementApi.new
5485
5482
  opts = {
5486
5483
  page_size: 1000, # Integer | The number of items in the response.
5487
5484
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
5488
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
5485
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5489
5486
  application_id: 3.4, # Float | Filter results by Application ID.
5490
5487
  entity_path: 'entity_path_example', # String | Filter results on a case insensitive matching of the url path of the entity
5491
5488
  user_id: 56, # Integer | Filter results by user ID.
@@ -5512,7 +5509,7 @@ Name | Type | Description | Notes
5512
5509
  ------------- | ------------- | ------------- | -------------
5513
5510
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
5514
5511
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
5515
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
5512
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
5516
5513
  **application_id** | **Float**| Filter results by Application ID. | [optional]
5517
5514
  **entity_path** | **String**| Filter results on a case insensitive matching of the url path of the entity | [optional]
5518
5515
  **user_id** | **Integer**| Filter results by user ID. | [optional]
@@ -5696,7 +5693,7 @@ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Tal
5696
5693
  opts = {
5697
5694
  page_size: 1000, # Integer | The number of items in the response.
5698
5695
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
5699
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
5696
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5700
5697
  value: 'value_example', # String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
5701
5698
  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 coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
5702
5699
  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 coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -5732,7 +5729,7 @@ Name | Type | Description | Notes
5732
5729
  **campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
5733
5730
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
5734
5731
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
5735
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
5732
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
5736
5733
  **value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
5737
5734
  **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
5738
5735
  **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
@@ -5867,7 +5864,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
5867
5864
  opts = {
5868
5865
  page_size: 1000, # Integer | The number of items in the response.
5869
5866
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
5870
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
5867
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5871
5868
  name: 'name_example', # String | Only return reports matching the customer name.
5872
5869
  integration_id: 'integration_id_example', # String | Filter results performing an exact matching against the profile integration identifier.
5873
5870
  campaign_name: 'campaign_name_example', # String | Only return reports matching the campaign name.
@@ -5893,7 +5890,7 @@ Name | Type | Description | Notes
5893
5890
  **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
5894
5891
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
5895
5892
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
5896
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
5893
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
5897
5894
  **name** | **String**| Only return reports matching the customer name. | [optional]
5898
5895
  **integration_id** | **String**| Filter results performing an exact matching against the profile integration identifier. | [optional]
5899
5896
  **campaign_name** | **String**| Only return reports matching the campaign name. | [optional]
@@ -5945,7 +5942,7 @@ customer_id = 56 # Integer | The value of the `id` property of a customer profil
5945
5942
  opts = {
5946
5943
  page_size: 1000, # Integer | The number of items in the response.
5947
5944
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
5948
- sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
5945
+ sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
5949
5946
  }
5950
5947
 
5951
5948
  begin
@@ -5966,7 +5963,7 @@ Name | Type | Description | Notes
5966
5963
  **customer_id** | **Integer**| The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. |
5967
5964
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
5968
5965
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
5969
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
5966
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
5970
5967
 
5971
5968
  ### Return type
5972
5969
 
@@ -6343,7 +6340,7 @@ opts = {
6343
6340
  include_old_versions: false, # Boolean | Include all versions of every event type.
6344
6341
  page_size: 1000, # Integer | The number of items in the response.
6345
6342
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
6346
- sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
6343
+ sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
6347
6344
  }
6348
6345
 
6349
6346
  begin
@@ -6364,7 +6361,7 @@ Name | Type | Description | Notes
6364
6361
  **include_old_versions** | **Boolean**| Include all versions of every event type. | [optional] [default to false]
6365
6362
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
6366
6363
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
6367
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
6364
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
6368
6365
 
6369
6366
  ### Return type
6370
6367
 
@@ -6614,7 +6611,7 @@ loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program
6614
6611
  opts = {
6615
6612
  page_size: 1000, # Integer | The number of items in the response.
6616
6613
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
6617
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
6614
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
6618
6615
  identifier: 'identifier_example', # String | The card code by which to filter loyalty cards in the response.
6619
6616
  profile_id: 56, # Integer | Filter results by customer profile ID.
6620
6617
  batch_id: 'batch_id_example' # String | Filter results by loyalty card batch ID.
@@ -6637,7 +6634,7 @@ Name | Type | Description | Notes
6637
6634
  **loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
6638
6635
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
6639
6636
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
6640
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
6637
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
6641
6638
  **identifier** | **String**| The card code by which to filter loyalty cards in the response. | [optional]
6642
6639
  **profile_id** | **Integer**| Filter results by customer profile ID. | [optional]
6643
6640
  **batch_id** | **String**| Filter results by loyalty card batch ID. | [optional]
@@ -6963,6 +6960,93 @@ Name | Type | Description | Notes
6963
6960
  - **Accept**: application/json
6964
6961
 
6965
6962
 
6963
+ ## get_message_logs
6964
+
6965
+ > MessageLogEntries get_message_logs(entity_type, opts)
6966
+
6967
+ List message log entries
6968
+
6969
+ Retrieve all message log entries.
6970
+
6971
+ ### Example
6972
+
6973
+ ```ruby
6974
+ # load the gem
6975
+ require 'talon_one'
6976
+ # setup authorization
6977
+ TalonOne.configure do |config|
6978
+ # Configure API key authorization: management_key
6979
+ config.api_key['Authorization'] = 'YOUR API KEY'
6980
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
6981
+ #config.api_key_prefix['Authorization'] = 'Bearer'
6982
+
6983
+ # Configure API key authorization: manager_auth
6984
+ config.api_key['Authorization'] = 'YOUR API KEY'
6985
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
6986
+ #config.api_key_prefix['Authorization'] = 'Bearer'
6987
+ end
6988
+
6989
+ api_instance = TalonOne::ManagementApi.new
6990
+ entity_type = 'entity_type_example' # String | The entity type the log is related to.
6991
+ opts = {
6992
+ message_id: 'message_id_example', # String | Filter results by message ID.
6993
+ change_type: 'change_type_example', # String | Filter results by change type.
6994
+ notification_i_ds: 'notification_i_ds_example', # String | Filter results by notification ID (include up to 30 values, separated by a comma).
6995
+ created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
6996
+ created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
6997
+ cursor: 'cursor_example', # String | A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.
6998
+ period: 'period_example', # String | Filter results by time period. Choose between the available relative time frames.
6999
+ is_successful: true, # Boolean | Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set to`true`, only log entries with `2xx` response codes are returned. When set to `false`, only log entries with `4xx` and `5xx` response codes are returned.
7000
+ application_id: 3.4, # Float | Filter results by Application ID.
7001
+ campaign_id: 3.4, # Float | Filter results by campaign ID.
7002
+ loyalty_program_id: 56, # Integer | Identifier of the loyalty program.
7003
+ response_code: 56, # Integer | Filter results by response status code.
7004
+ webhook_i_ds: 'webhook_i_ds_example' # String | Filter results by webhook ID (include up to 30 values, separated by a comma).
7005
+ }
7006
+
7007
+ begin
7008
+ #List message log entries
7009
+ result = api_instance.get_message_logs(entity_type, opts)
7010
+ p result
7011
+ rescue TalonOne::ApiError => e
7012
+ puts "Exception when calling ManagementApi->get_message_logs: #{e}"
7013
+ end
7014
+ ```
7015
+
7016
+ ### Parameters
7017
+
7018
+
7019
+ Name | Type | Description | Notes
7020
+ ------------- | ------------- | ------------- | -------------
7021
+ **entity_type** | **String**| The entity type the log is related to. |
7022
+ **message_id** | **String**| Filter results by message ID. | [optional]
7023
+ **change_type** | **String**| Filter results by change type. | [optional]
7024
+ **notification_i_ds** | **String**| Filter results by notification ID (include up to 30 values, separated by a comma). | [optional]
7025
+ **created_before** | **DateTime**| Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
7026
+ **created_after** | **DateTime**| Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
7027
+ **cursor** | **String**| A specific unique value in the database. If this value is not given, the server fetches results starting with the first record. | [optional]
7028
+ **period** | **String**| Filter results by time period. Choose between the available relative time frames. | [optional]
7029
+ **is_successful** | **Boolean**| Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set to`true`, only log entries with `2xx` response codes are returned. When set to `false`, only log entries with `4xx` and `5xx` response codes are returned. | [optional]
7030
+ **application_id** | **Float**| Filter results by Application ID. | [optional]
7031
+ **campaign_id** | **Float**| Filter results by campaign ID. | [optional]
7032
+ **loyalty_program_id** | **Integer**| Identifier of the loyalty program. | [optional]
7033
+ **response_code** | **Integer**| Filter results by response status code. | [optional]
7034
+ **webhook_i_ds** | **String**| Filter results by webhook ID (include up to 30 values, separated by a comma). | [optional]
7035
+
7036
+ ### Return type
7037
+
7038
+ [**MessageLogEntries**](MessageLogEntries.md)
7039
+
7040
+ ### Authorization
7041
+
7042
+ [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
7043
+
7044
+ ### HTTP request headers
7045
+
7046
+ - **Content-Type**: Not defined
7047
+ - **Accept**: application/json
7048
+
7049
+
6966
7050
  ## get_referrals_without_total_count
6967
7051
 
6968
7052
  > InlineResponse20012 get_referrals_without_total_count(application_id, campaign_id, opts)
@@ -6995,7 +7079,7 @@ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Tal
6995
7079
  opts = {
6996
7080
  page_size: 1000, # Integer | The number of items in the response.
6997
7081
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
6998
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
7082
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
6999
7083
  code: 'code_example', # String | Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
7000
7084
  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 referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
7001
7085
  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 referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -7022,7 +7106,7 @@ Name | Type | Description | Notes
7022
7106
  **campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
7023
7107
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
7024
7108
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
7025
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
7109
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
7026
7110
  **code** | **String**| Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
7027
7111
  **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
7028
7112
  **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
@@ -7198,7 +7282,7 @@ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Tal
7198
7282
  opts = {
7199
7283
  page_size: 1000, # Integer | The number of items in the response.
7200
7284
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
7201
- sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
7285
+ sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
7202
7286
  }
7203
7287
 
7204
7288
  begin
@@ -7219,7 +7303,7 @@ Name | Type | Description | Notes
7219
7303
  **campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
7220
7304
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
7221
7305
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
7222
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
7306
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
7223
7307
 
7224
7308
  ### Return type
7225
7309
 
@@ -7385,7 +7469,7 @@ api_instance = TalonOne::ManagementApi.new
7385
7469
  opts = {
7386
7470
  page_size: 1000, # Integer | The number of items in the response.
7387
7471
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
7388
- sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
7472
+ sort: 'sort_example' # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
7389
7473
  }
7390
7474
 
7391
7475
  begin
@@ -7404,7 +7488,7 @@ Name | Type | Description | Notes
7404
7488
  ------------- | ------------- | ------------- | -------------
7405
7489
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
7406
7490
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
7407
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
7491
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
7408
7492
 
7409
7493
  ### Return type
7410
7494
 
@@ -7509,7 +7593,7 @@ api_instance = TalonOne::ManagementApi.new
7509
7593
  opts = {
7510
7594
  page_size: 1000, # Integer | The number of items in the response.
7511
7595
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
7512
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
7596
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
7513
7597
  integration_request_uuid: 'integration_request_uuid_example', # String | Filter results by integration request UUID.
7514
7598
  webhook_id: 3.4, # Float | Filter results by webhook id.
7515
7599
  application_id: 3.4, # Float | Filter results by Application ID.
@@ -7534,7 +7618,7 @@ Name | Type | Description | Notes
7534
7618
  ------------- | ------------- | ------------- | -------------
7535
7619
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
7536
7620
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
7537
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
7621
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
7538
7622
  **integration_request_uuid** | **String**| Filter results by integration request UUID. | [optional]
7539
7623
  **webhook_id** | **Float**| Filter results by webhook id. | [optional]
7540
7624
  **application_id** | **Float**| Filter results by Application ID. | [optional]
@@ -7586,7 +7670,7 @@ api_instance = TalonOne::ManagementApi.new
7586
7670
  opts = {
7587
7671
  page_size: 1000, # Integer | The number of items in the response.
7588
7672
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
7589
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
7673
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
7590
7674
  status: 'status_example', # String | Filter results by HTTP status codes.
7591
7675
  webhook_id: 3.4, # Float | Filter results by webhook id.
7592
7676
  application_id: 3.4, # Float | Filter results by Application ID.
@@ -7612,7 +7696,7 @@ Name | Type | Description | Notes
7612
7696
  ------------- | ------------- | ------------- | -------------
7613
7697
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
7614
7698
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
7615
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
7699
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
7616
7700
  **status** | **String**| Filter results by HTTP status codes. | [optional]
7617
7701
  **webhook_id** | **Float**| Filter results by webhook id. | [optional]
7618
7702
  **application_id** | **Float**| Filter results by Application ID. | [optional]
@@ -7664,7 +7748,7 @@ end
7664
7748
  api_instance = TalonOne::ManagementApi.new
7665
7749
  opts = {
7666
7750
  application_ids: 'application_ids_example', # String | Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.
7667
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
7751
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
7668
7752
  page_size: 1000, # Integer | The number of items in the response.
7669
7753
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
7670
7754
  creation_type: 'creation_type_example', # String | Filter results by creation type.
@@ -7688,7 +7772,7 @@ end
7688
7772
  Name | Type | Description | Notes
7689
7773
  ------------- | ------------- | ------------- | -------------
7690
7774
  **application_ids** | **String**| Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications. | [optional]
7691
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
7775
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
7692
7776
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
7693
7777
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
7694
7778
  **creation_type** | **String**| Filter results by creation type. | [optional]
@@ -8503,7 +8587,7 @@ api_instance = TalonOne::ManagementApi.new
8503
8587
  opts = {
8504
8588
  page_size: 1000, # Integer | The number of items in the response.
8505
8589
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
8506
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
8590
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
8507
8591
  with_total_result_size: true, # Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
8508
8592
  name: 'name_example' # String | Filter by collection name.
8509
8593
  }
@@ -8524,7 +8608,7 @@ Name | Type | Description | Notes
8524
8608
  ------------- | ------------- | ------------- | -------------
8525
8609
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
8526
8610
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
8527
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
8611
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
8528
8612
  **with_total_result_size** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
8529
8613
  **name** | **String**| Filter by collection name. | [optional]
8530
8614
 
@@ -8769,7 +8853,7 @@ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Tal
8769
8853
  opts = {
8770
8854
  page_size: 1000, # Integer | The number of items in the response.
8771
8855
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
8772
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
8856
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
8773
8857
  with_total_result_size: true, # Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
8774
8858
  name: 'name_example' # String | Filter by collection name.
8775
8859
  }
@@ -8792,7 +8876,7 @@ Name | Type | Description | Notes
8792
8876
  **campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
8793
8877
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
8794
8878
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
8795
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
8879
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
8796
8880
  **with_total_result_size** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
8797
8881
  **name** | **String**| Filter by collection name. | [optional]
8798
8882
 
@@ -8841,7 +8925,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
8841
8925
  opts = {
8842
8926
  page_size: 1000, # Integer | The number of items in the response.
8843
8927
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
8844
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
8928
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
8845
8929
  with_total_result_size: true, # Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
8846
8930
  name: 'name_example' # String | Filter by collection name.
8847
8931
  }
@@ -8863,7 +8947,7 @@ Name | Type | Description | Notes
8863
8947
  **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
8864
8948
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
8865
8949
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
8866
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
8950
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
8867
8951
  **with_total_result_size** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
8868
8952
  **name** | **String**| Filter by collection name. | [optional]
8869
8953
 
@@ -8912,7 +8996,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
8912
8996
  opts = {
8913
8997
  page_size: 1000, # Integer | The number of items in the response.
8914
8998
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
8915
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
8999
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
8916
9000
  with_total_result_size: true, # Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
8917
9001
  campaign_id: 3.4, # Float | Filter results by campaign ID.
8918
9002
  name: 'name_example', # String | The name of the store.
@@ -8937,7 +9021,7 @@ Name | Type | Description | Notes
8937
9021
  **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
8938
9022
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
8939
9023
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
8940
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
9024
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
8941
9025
  **with_total_result_size** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
8942
9026
  **campaign_id** | **Float**| Filter results by campaign ID. | [optional]
8943
9027
  **name** | **String**| The name of the store. | [optional]
@@ -8958,66 +9042,6 @@ Name | Type | Description | Notes
8958
9042
  - **Accept**: application/json
8959
9043
 
8960
9044
 
8961
- ## notification_activation
8962
-
8963
- > notification_activation(notification_id, body)
8964
-
8965
- Activate or deactivate notification
8966
-
8967
- Activate or deactivate the given notification. When `enabled` is false, updates will no longer be sent for the given notification.
8968
-
8969
- ### Example
8970
-
8971
- ```ruby
8972
- # load the gem
8973
- require 'talon_one'
8974
- # setup authorization
8975
- TalonOne.configure do |config|
8976
- # Configure API key authorization: management_key
8977
- config.api_key['Authorization'] = 'YOUR API KEY'
8978
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
8979
- #config.api_key_prefix['Authorization'] = 'Bearer'
8980
-
8981
- # Configure API key authorization: manager_auth
8982
- config.api_key['Authorization'] = 'YOUR API KEY'
8983
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
8984
- #config.api_key_prefix['Authorization'] = 'Bearer'
8985
- end
8986
-
8987
- api_instance = TalonOne::ManagementApi.new
8988
- notification_id = 56 # Integer | The ID of the notification. Get it with the appropriate _List notifications_ endpoint.
8989
- body = TalonOne::NotificationActivation.new # NotificationActivation | body
8990
-
8991
- begin
8992
- #Activate or deactivate notification
8993
- api_instance.notification_activation(notification_id, body)
8994
- rescue TalonOne::ApiError => e
8995
- puts "Exception when calling ManagementApi->notification_activation: #{e}"
8996
- end
8997
- ```
8998
-
8999
- ### Parameters
9000
-
9001
-
9002
- Name | Type | Description | Notes
9003
- ------------- | ------------- | ------------- | -------------
9004
- **notification_id** | **Integer**| The ID of the notification. Get it with the appropriate _List notifications_ endpoint. |
9005
- **body** | [**NotificationActivation**](NotificationActivation.md)| body |
9006
-
9007
- ### Return type
9008
-
9009
- nil (empty response body)
9010
-
9011
- ### Authorization
9012
-
9013
- [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
9014
-
9015
- ### HTTP request headers
9016
-
9017
- - **Content-Type**: application/json
9018
- - **Accept**: Not defined
9019
-
9020
-
9021
9045
  ## okta_event_handler_challenge
9022
9046
 
9023
9047
  > okta_event_handler_challenge
@@ -9072,189 +9096,6 @@ nil (empty response body)
9072
9096
  - **Accept**: Not defined
9073
9097
 
9074
9098
 
9075
- ## post_added_deducted_points_notification
9076
-
9077
- > BaseNotification post_added_deducted_points_notification(loyalty_program_id, body)
9078
-
9079
- Create notification about added or deducted loyalty points
9080
-
9081
- Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
9082
-
9083
- ### Example
9084
-
9085
- ```ruby
9086
- # load the gem
9087
- require 'talon_one'
9088
- # setup authorization
9089
- TalonOne.configure do |config|
9090
- # Configure API key authorization: management_key
9091
- config.api_key['Authorization'] = 'YOUR API KEY'
9092
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9093
- #config.api_key_prefix['Authorization'] = 'Bearer'
9094
-
9095
- # Configure API key authorization: manager_auth
9096
- config.api_key['Authorization'] = 'YOUR API KEY'
9097
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9098
- #config.api_key_prefix['Authorization'] = 'Bearer'
9099
- end
9100
-
9101
- api_instance = TalonOne::ManagementApi.new
9102
- loyalty_program_id = 56 # Integer | Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
9103
- body = TalonOne::NewBaseNotification.new # NewBaseNotification | body
9104
-
9105
- begin
9106
- #Create notification about added or deducted loyalty points
9107
- result = api_instance.post_added_deducted_points_notification(loyalty_program_id, body)
9108
- p result
9109
- rescue TalonOne::ApiError => e
9110
- puts "Exception when calling ManagementApi->post_added_deducted_points_notification: #{e}"
9111
- end
9112
- ```
9113
-
9114
- ### Parameters
9115
-
9116
-
9117
- Name | Type | Description | Notes
9118
- ------------- | ------------- | ------------- | -------------
9119
- **loyalty_program_id** | **Integer**| Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
9120
- **body** | [**NewBaseNotification**](NewBaseNotification.md)| body |
9121
-
9122
- ### Return type
9123
-
9124
- [**BaseNotification**](BaseNotification.md)
9125
-
9126
- ### Authorization
9127
-
9128
- [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
9129
-
9130
- ### HTTP request headers
9131
-
9132
- - **Content-Type**: application/json
9133
- - **Accept**: application/json
9134
-
9135
-
9136
- ## post_catalogs_strikethrough_notification
9137
-
9138
- > BaseNotification post_catalogs_strikethrough_notification(application_id, body)
9139
-
9140
- Create strikethrough notification
9141
-
9142
- Create a notification for the in the given Application. For more information, see [Application notifications](https://docs.talon.one/docs/product/applications/application-notifications/overview). See the [payload](https://docs.talon.one/outbound-notifications) you will receive.
9143
-
9144
- ### Example
9145
-
9146
- ```ruby
9147
- # load the gem
9148
- require 'talon_one'
9149
- # setup authorization
9150
- TalonOne.configure do |config|
9151
- # Configure API key authorization: management_key
9152
- config.api_key['Authorization'] = 'YOUR API KEY'
9153
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9154
- #config.api_key_prefix['Authorization'] = 'Bearer'
9155
-
9156
- # Configure API key authorization: manager_auth
9157
- config.api_key['Authorization'] = 'YOUR API KEY'
9158
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9159
- #config.api_key_prefix['Authorization'] = 'Bearer'
9160
- end
9161
-
9162
- api_instance = TalonOne::ManagementApi.new
9163
- application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
9164
- body = TalonOne::NewBaseNotification.new # NewBaseNotification | body
9165
-
9166
- begin
9167
- #Create strikethrough notification
9168
- result = api_instance.post_catalogs_strikethrough_notification(application_id, body)
9169
- p result
9170
- rescue TalonOne::ApiError => e
9171
- puts "Exception when calling ManagementApi->post_catalogs_strikethrough_notification: #{e}"
9172
- end
9173
- ```
9174
-
9175
- ### Parameters
9176
-
9177
-
9178
- Name | Type | Description | Notes
9179
- ------------- | ------------- | ------------- | -------------
9180
- **application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
9181
- **body** | [**NewBaseNotification**](NewBaseNotification.md)| body |
9182
-
9183
- ### Return type
9184
-
9185
- [**BaseNotification**](BaseNotification.md)
9186
-
9187
- ### Authorization
9188
-
9189
- [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
9190
-
9191
- ### HTTP request headers
9192
-
9193
- - **Content-Type**: application/json
9194
- - **Accept**: application/json
9195
-
9196
-
9197
- ## post_pending_points_notification
9198
-
9199
- > BaseNotification post_pending_points_notification(loyalty_program_id, body)
9200
-
9201
- Create notification about pending loyalty points
9202
-
9203
- Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
9204
-
9205
- ### Example
9206
-
9207
- ```ruby
9208
- # load the gem
9209
- require 'talon_one'
9210
- # setup authorization
9211
- TalonOne.configure do |config|
9212
- # Configure API key authorization: management_key
9213
- config.api_key['Authorization'] = 'YOUR API KEY'
9214
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9215
- #config.api_key_prefix['Authorization'] = 'Bearer'
9216
-
9217
- # Configure API key authorization: manager_auth
9218
- config.api_key['Authorization'] = 'YOUR API KEY'
9219
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9220
- #config.api_key_prefix['Authorization'] = 'Bearer'
9221
- end
9222
-
9223
- api_instance = TalonOne::ManagementApi.new
9224
- loyalty_program_id = 56 # Integer | Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
9225
- body = TalonOne::NewBaseNotification.new # NewBaseNotification | body
9226
-
9227
- begin
9228
- #Create notification about pending loyalty points
9229
- result = api_instance.post_pending_points_notification(loyalty_program_id, body)
9230
- p result
9231
- rescue TalonOne::ApiError => e
9232
- puts "Exception when calling ManagementApi->post_pending_points_notification: #{e}"
9233
- end
9234
- ```
9235
-
9236
- ### Parameters
9237
-
9238
-
9239
- Name | Type | Description | Notes
9240
- ------------- | ------------- | ------------- | -------------
9241
- **loyalty_program_id** | **Integer**| Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
9242
- **body** | [**NewBaseNotification**](NewBaseNotification.md)| body |
9243
-
9244
- ### Return type
9245
-
9246
- [**BaseNotification**](BaseNotification.md)
9247
-
9248
- ### Authorization
9249
-
9250
- [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
9251
-
9252
- ### HTTP request headers
9253
-
9254
- - **Content-Type**: application/json
9255
- - **Accept**: application/json
9256
-
9257
-
9258
9099
  ## remove_loyalty_points
9259
9100
 
9260
9101
  > remove_loyalty_points(loyalty_program_id, integration_id, body)
@@ -9926,7 +9767,7 @@ body = nil # Object | body
9926
9767
  opts = {
9927
9768
  page_size: 1000, # Integer | The number of items in the response.
9928
9769
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
9929
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
9770
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
9930
9771
  value: 'value_example', # String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
9931
9772
  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 coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
9932
9773
  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 coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -9957,7 +9798,7 @@ Name | Type | Description | Notes
9957
9798
  **body** | **Object**| body |
9958
9799
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
9959
9800
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
9960
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
9801
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
9961
9802
  **value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
9962
9803
  **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
9963
9804
  **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
@@ -10016,7 +9857,7 @@ body = nil # Object | body
10016
9857
  opts = {
10017
9858
  page_size: 1000, # Integer | The number of items in the response.
10018
9859
  skip: 56, # Integer | The number of items to skip when paging through large result sets.
10019
- sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields.
9860
+ sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
10020
9861
  value: 'value_example', # String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
10021
9862
  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 coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
10022
9863
  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 coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
@@ -10047,7 +9888,7 @@ Name | Type | Description | Notes
10047
9888
  **body** | **Object**| body |
10048
9889
  **page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
10049
9890
  **skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
10050
- **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | [optional]
9891
+ **sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
10051
9892
  **value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
10052
9893
  **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
10053
9894
  **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
@@ -10810,7 +10651,7 @@ end
10810
10651
  Name | Type | Description | Notes
10811
10652
  ------------- | ------------- | ------------- | -------------
10812
10653
  **role_id** | **Integer**| The ID of role. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint. |
10813
- **body** | **RoleV2Base**| body |
10654
+ **body** | [**RoleV2Base**](RoleV2Base.md)| body |
10814
10655
 
10815
10656
  ### Return type
10816
10657