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.
- checksums.yaml +4 -4
- data/README.md +6 -8
- data/docs/AchievementBase.md +35 -0
- data/docs/AchievementProgressWithDefinition.md +45 -0
- data/docs/AchievementStatusEntry.md +45 -0
- data/docs/AnalyticsSKU.md +23 -0
- data/docs/ApplicationCIFReferences.md +19 -0
- data/docs/CampaignDetail.md +19 -0
- data/docs/CampaignStoreBudgetLimitConfig.md +25 -0
- data/docs/CampaignTemplate.md +3 -1
- data/docs/HiddenConditionsEffects.md +23 -0
- data/docs/InlineResponse20048.md +19 -0
- data/docs/InlineResponse20049.md +19 -0
- data/docs/IntegrationApi.md +3 -1
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/LoyaltyLedgerEntryFlags.md +17 -0
- data/docs/LoyaltyProgramTransaction.md +3 -1
- data/docs/ManagementApi.md +164 -323
- data/docs/MessageTest.md +27 -0
- data/docs/NewMessageTest.md +29 -0
- data/docs/ProductUnitAnalyticsDataPoint.md +25 -0
- data/docs/ProductUnitAnalyticsTotals.md +17 -0
- data/docs/SkuUnitAnalytics.md +19 -0
- data/docs/SkuUnitAnalyticsDataPoint.md +23 -0
- data/docs/StrikethroughLabelingNotification.md +2 -0
- data/lib/talon_one/api/integration_api.rb +3 -0
- data/lib/talon_one/api/management_api.rb +191 -354
- data/lib/talon_one/models/achievement_base.rb +377 -0
- data/lib/talon_one/models/achievement_progress_with_definition.rb +490 -0
- data/lib/talon_one/models/achievement_status_entry.rb +472 -0
- data/lib/talon_one/models/analytics_sku.rb +246 -0
- data/lib/talon_one/models/application_cif_references.rb +219 -0
- data/lib/talon_one/models/campaign_detail.rb +232 -0
- data/lib/talon_one/models/campaign_store_budget_limit_config.rb +322 -0
- data/lib/talon_one/models/campaign_template.rb +16 -4
- data/lib/talon_one/models/delete_user_request.rb +0 -1
- data/lib/talon_one/models/hidden_conditions_effects.rb +246 -0
- data/lib/talon_one/models/inline_response20048.rb +222 -0
- data/lib/talon_one/models/inline_response20049.rb +227 -0
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +13 -4
- data/lib/talon_one/models/loyalty_ledger_entry_flags.rb +208 -0
- data/lib/talon_one/models/loyalty_program_transaction.rb +13 -4
- data/lib/talon_one/models/message_test.rb +227 -0
- data/lib/talon_one/models/new_message_test.rb +322 -0
- data/lib/talon_one/models/product_unit_analytics_data_point.rb +271 -0
- data/lib/talon_one/models/product_unit_analytics_totals.rb +206 -0
- data/lib/talon_one/models/sku_unit_analytics.rb +227 -0
- data/lib/talon_one/models/sku_unit_analytics_data_point.rb +256 -0
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +11 -1
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +2 -1
- data/spec/api/integration_api_spec.rb +1 -0
- data/spec/api/management_api_spec.rb +60 -87
- data/spec/models/campaign_template_spec.rb +6 -0
- data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/loyalty_program_transaction_spec.rb +6 -0
- data/spec/models/revision_activation_request_spec.rb +47 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +6 -0
- metadata +563 -527
@@ -21,7 +21,7 @@ module TalonOne
|
|
21
21
|
end
|
22
22
|
# Enable user by email address
|
23
23
|
# Enable a [disabled user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
|
24
|
-
# @param body [
|
24
|
+
# @param body [DeleteUserRequest] body
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @return [nil]
|
27
27
|
def activate_user_by_email(body, opts = {})
|
@@ -31,7 +31,7 @@ module TalonOne
|
|
31
31
|
|
32
32
|
# Enable user by email address
|
33
33
|
# Enable a [disabled user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
|
34
|
-
# @param body [
|
34
|
+
# @param body [DeleteUserRequest] body
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
36
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
37
37
|
def activate_user_by_email_with_http_info(body, opts = {})
|
@@ -1435,7 +1435,7 @@ module TalonOne
|
|
1435
1435
|
|
1436
1436
|
# Disable user by email address
|
1437
1437
|
# [Disable a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
|
1438
|
-
# @param body [
|
1438
|
+
# @param body [DeleteUserRequest] body
|
1439
1439
|
# @param [Hash] opts the optional parameters
|
1440
1440
|
# @return [nil]
|
1441
1441
|
def deactivate_user_by_email(body, opts = {})
|
@@ -1445,7 +1445,7 @@ module TalonOne
|
|
1445
1445
|
|
1446
1446
|
# Disable user by email address
|
1447
1447
|
# [Disable a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address.
|
1448
|
-
# @param body [
|
1448
|
+
# @param body [DeleteUserRequest] body
|
1449
1449
|
# @param [Hash] opts the optional parameters
|
1450
1450
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1451
1451
|
def deactivate_user_by_email_with_http_info(body, opts = {})
|
@@ -2310,7 +2310,7 @@ module TalonOne
|
|
2310
2310
|
|
2311
2311
|
# Delete user by email address
|
2312
2312
|
# [Delete a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address.
|
2313
|
-
# @param body [
|
2313
|
+
# @param body [DeleteUserRequest] body
|
2314
2314
|
# @param [Hash] opts the optional parameters
|
2315
2315
|
# @return [nil]
|
2316
2316
|
def delete_user_by_email(body, opts = {})
|
@@ -2320,7 +2320,7 @@ module TalonOne
|
|
2320
2320
|
|
2321
2321
|
# Delete user by email address
|
2322
2322
|
# [Delete a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address.
|
2323
|
-
# @param body [
|
2323
|
+
# @param body [DeleteUserRequest] body
|
2324
2324
|
# @param [Hash] opts the optional parameters
|
2325
2325
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
2326
2326
|
def delete_user_by_email_with_http_info(body, opts = {})
|
@@ -2837,7 +2837,7 @@ module TalonOne
|
|
2837
2837
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2838
2838
|
# @param [Hash] opts the optional parameters
|
2839
2839
|
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
2840
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
2840
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
2841
2841
|
# @option opts [String] :value 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.
|
2842
2842
|
# @option opts [DateTime] :created_before 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.
|
2843
2843
|
# @option opts [DateTime] :created_after 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.
|
@@ -2861,7 +2861,7 @@ module TalonOne
|
|
2861
2861
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2862
2862
|
# @param [Hash] opts the optional parameters
|
2863
2863
|
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
2864
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
2864
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
2865
2865
|
# @option opts [String] :value 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.
|
2866
2866
|
# @option opts [DateTime] :created_before 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.
|
2867
2867
|
# @option opts [DateTime] :created_after 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.
|
@@ -3544,7 +3544,7 @@ module TalonOne
|
|
3544
3544
|
end
|
3545
3545
|
|
3546
3546
|
# Export customer's transaction logs
|
3547
|
-
# 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.
|
3547
|
+
# 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.
|
3548
3548
|
# @param range_start [DateTime] Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
3549
3549
|
# @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
3550
3550
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
@@ -3558,7 +3558,7 @@ module TalonOne
|
|
3558
3558
|
end
|
3559
3559
|
|
3560
3560
|
# Export customer's transaction logs
|
3561
|
-
# 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.
|
3561
|
+
# 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.
|
3562
3562
|
# @param range_start [DateTime] Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
3563
3563
|
# @param range_end [DateTime] Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
3564
3564
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
@@ -3806,7 +3806,7 @@ module TalonOne
|
|
3806
3806
|
# @option opts [String] :status Filter results by HTTP status codes.
|
3807
3807
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
3808
3808
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
3809
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
3809
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
3810
3810
|
# @return [InlineResponse20022]
|
3811
3811
|
def get_access_logs_without_total_count(application_id, range_start, range_end, opts = {})
|
3812
3812
|
data, _status_code, _headers = get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts)
|
@@ -3824,7 +3824,7 @@ module TalonOne
|
|
3824
3824
|
# @option opts [String] :status Filter results by HTTP status codes.
|
3825
3825
|
# @option opts [Integer] :page_size The number of items in the response.
|
3826
3826
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
3827
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
3827
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
3828
3828
|
# @return [Array<(InlineResponse20022, Integer, Hash)>] InlineResponse20022 data, response status code and response headers
|
3829
3829
|
def get_access_logs_without_total_count_with_http_info(application_id, range_start, range_end, opts = {})
|
3830
3830
|
if @api_client.config.debugging
|
@@ -4232,7 +4232,7 @@ module TalonOne
|
|
4232
4232
|
# @param [Hash] opts the optional parameters
|
4233
4233
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4234
4234
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4235
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
4235
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
4236
4236
|
# @return [InlineResponse20038]
|
4237
4237
|
def get_additional_costs(opts = {})
|
4238
4238
|
data, _status_code, _headers = get_additional_costs_with_http_info(opts)
|
@@ -4244,7 +4244,7 @@ module TalonOne
|
|
4244
4244
|
# @param [Hash] opts the optional parameters
|
4245
4245
|
# @option opts [Integer] :page_size The number of items in the response.
|
4246
4246
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4247
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
4247
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
4248
4248
|
# @return [Array<(InlineResponse20038, Integer, Hash)>] InlineResponse20038 data, response status code and response headers
|
4249
4249
|
def get_additional_costs_with_http_info(opts = {})
|
4250
4250
|
if @api_client.config.debugging
|
@@ -4499,7 +4499,7 @@ module TalonOne
|
|
4499
4499
|
# @param [Hash] opts the optional parameters
|
4500
4500
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4501
4501
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4502
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
4502
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
4503
4503
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
4504
4504
|
# @return [InlineResponse20035]
|
4505
4505
|
def get_application_customer_friends(application_id, integration_id, opts = {})
|
@@ -4514,7 +4514,7 @@ module TalonOne
|
|
4514
4514
|
# @param [Hash] opts the optional parameters
|
4515
4515
|
# @option opts [Integer] :page_size The number of items in the response.
|
4516
4516
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4517
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
4517
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
4518
4518
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
4519
4519
|
# @return [Array<(InlineResponse20035, Integer, Hash)>] InlineResponse20035 data, response status code and response headers
|
4520
4520
|
def get_application_customer_friends_with_http_info(application_id, integration_id, opts = {})
|
@@ -4755,7 +4755,7 @@ module TalonOne
|
|
4755
4755
|
# @param [Hash] opts the optional parameters
|
4756
4756
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4757
4757
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4758
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
4758
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
4759
4759
|
# @return [InlineResponse20031]
|
4760
4760
|
def get_application_event_types(application_id, opts = {})
|
4761
4761
|
data, _status_code, _headers = get_application_event_types_with_http_info(application_id, opts)
|
@@ -4768,7 +4768,7 @@ module TalonOne
|
|
4768
4768
|
# @param [Hash] opts the optional parameters
|
4769
4769
|
# @option opts [Integer] :page_size The number of items in the response.
|
4770
4770
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4771
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
4771
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
4772
4772
|
# @return [Array<(InlineResponse20031, Integer, Hash)>] InlineResponse20031 data, response status code and response headers
|
4773
4773
|
def get_application_event_types_with_http_info(application_id, opts = {})
|
4774
4774
|
if @api_client.config.debugging
|
@@ -4834,7 +4834,7 @@ module TalonOne
|
|
4834
4834
|
# @param [Hash] opts the optional parameters
|
4835
4835
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
4836
4836
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4837
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
4837
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
4838
4838
|
# @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
|
4839
4839
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
4840
4840
|
# @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -4858,7 +4858,7 @@ module TalonOne
|
|
4858
4858
|
# @param [Hash] opts the optional parameters
|
4859
4859
|
# @option opts [Integer] :page_size The number of items in the response.
|
4860
4860
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
4861
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
4861
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
4862
4862
|
# @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
|
4863
4863
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
4864
4864
|
# @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -5022,7 +5022,7 @@ module TalonOne
|
|
5022
5022
|
# @param [Hash] opts the optional parameters
|
5023
5023
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
5024
5024
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5025
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5025
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5026
5026
|
# @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
|
5027
5027
|
# @option opts [String] :state Filter by sessions with this state. Must be exact match.
|
5028
5028
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -5043,7 +5043,7 @@ module TalonOne
|
|
5043
5043
|
# @param [Hash] opts the optional parameters
|
5044
5044
|
# @option opts [Integer] :page_size The number of items in the response.
|
5045
5045
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5046
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5046
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5047
5047
|
# @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
|
5048
5048
|
# @option opts [String] :state Filter by sessions with this state. Must be exact match.
|
5049
5049
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -5128,7 +5128,7 @@ module TalonOne
|
|
5128
5128
|
# @param [Hash] opts the optional parameters
|
5129
5129
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
5130
5130
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5131
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5131
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5132
5132
|
# @return [InlineResponse2007]
|
5133
5133
|
def get_applications(opts = {})
|
5134
5134
|
data, _status_code, _headers = get_applications_with_http_info(opts)
|
@@ -5140,7 +5140,7 @@ module TalonOne
|
|
5140
5140
|
# @param [Hash] opts the optional parameters
|
5141
5141
|
# @option opts [Integer] :page_size The number of items in the response.
|
5142
5142
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5143
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5143
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5144
5144
|
# @return [Array<(InlineResponse2007, Integer, Hash)>] InlineResponse2007 data, response status code and response headers
|
5145
5145
|
def get_applications_with_http_info(opts = {})
|
5146
5146
|
if @api_client.config.debugging
|
@@ -5263,7 +5263,7 @@ module TalonOne
|
|
5263
5263
|
# @param [Hash] opts the optional parameters
|
5264
5264
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
5265
5265
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5266
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5266
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5267
5267
|
# @option opts [String] :entity Returned attributes will be filtered by supplied entity.
|
5268
5268
|
# @return [InlineResponse20036]
|
5269
5269
|
def get_attributes(opts = {})
|
@@ -5276,7 +5276,7 @@ module TalonOne
|
|
5276
5276
|
# @param [Hash] opts the optional parameters
|
5277
5277
|
# @option opts [Integer] :page_size The number of items in the response.
|
5278
5278
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5279
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5279
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5280
5280
|
# @option opts [String] :entity Returned attributes will be filtered by supplied entity.
|
5281
5281
|
# @return [Array<(InlineResponse20036, Integer, Hash)>] InlineResponse20036 data, response status code and response headers
|
5282
5282
|
def get_attributes_with_http_info(opts = {})
|
@@ -5340,7 +5340,7 @@ module TalonOne
|
|
5340
5340
|
# @param [Hash] opts the optional parameters
|
5341
5341
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
5342
5342
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5343
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5343
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5344
5344
|
# @option opts [String] :profile_query The filter to select a profile.
|
5345
5345
|
# @return [InlineResponse20034]
|
5346
5346
|
def get_audience_memberships(audience_id, opts = {})
|
@@ -5354,7 +5354,7 @@ module TalonOne
|
|
5354
5354
|
# @param [Hash] opts the optional parameters
|
5355
5355
|
# @option opts [Integer] :page_size The number of items in the response.
|
5356
5356
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5357
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5357
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5358
5358
|
# @option opts [String] :profile_query The filter to select a profile.
|
5359
5359
|
# @return [Array<(InlineResponse20034, Integer, Hash)>] InlineResponse20034 data, response status code and response headers
|
5360
5360
|
def get_audience_memberships_with_http_info(audience_id, opts = {})
|
@@ -5421,7 +5421,7 @@ module TalonOne
|
|
5421
5421
|
# @param [Hash] opts the optional parameters
|
5422
5422
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
5423
5423
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5424
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5424
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5425
5425
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
5426
5426
|
# @return [InlineResponse20032]
|
5427
5427
|
def get_audiences(opts = {})
|
@@ -5434,7 +5434,7 @@ module TalonOne
|
|
5434
5434
|
# @param [Hash] opts the optional parameters
|
5435
5435
|
# @option opts [Integer] :page_size The number of items in the response.
|
5436
5436
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5437
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5437
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5438
5438
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
5439
5439
|
# @return [Array<(InlineResponse20032, Integer, Hash)>] InlineResponse20032 data, response status code and response headers
|
5440
5440
|
def get_audiences_with_http_info(opts = {})
|
@@ -5496,7 +5496,7 @@ module TalonOne
|
|
5496
5496
|
# Get a list of audience IDs and their member count.
|
5497
5497
|
# @param audience_ids [String] The IDs of one or more audiences, separated by commas, by which to filter results.
|
5498
5498
|
# @param [Hash] opts the optional parameters
|
5499
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5499
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5500
5500
|
# @return [InlineResponse20033]
|
5501
5501
|
def get_audiences_analytics(audience_ids, opts = {})
|
5502
5502
|
data, _status_code, _headers = get_audiences_analytics_with_http_info(audience_ids, opts)
|
@@ -5507,7 +5507,7 @@ module TalonOne
|
|
5507
5507
|
# Get a list of audience IDs and their member count.
|
5508
5508
|
# @param audience_ids [String] The IDs of one or more audiences, separated by commas, by which to filter results.
|
5509
5509
|
# @param [Hash] opts the optional parameters
|
5510
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5510
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5511
5511
|
# @return [Array<(InlineResponse20033, Integer, Hash)>] InlineResponse20033 data, response status code and response headers
|
5512
5512
|
def get_audiences_analytics_with_http_info(audience_ids, opts = {})
|
5513
5513
|
if @api_client.config.debugging
|
@@ -5722,7 +5722,7 @@ module TalonOne
|
|
5722
5722
|
# @param [Hash] opts the optional parameters
|
5723
5723
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
5724
5724
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5725
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5725
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5726
5726
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
5727
5727
|
# @return [InlineResponse2008]
|
5728
5728
|
def get_campaign_by_attributes(application_id, body, opts = {})
|
@@ -5737,7 +5737,7 @@ module TalonOne
|
|
5737
5737
|
# @param [Hash] opts the optional parameters
|
5738
5738
|
# @option opts [Integer] :page_size The number of items in the response.
|
5739
5739
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5740
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5740
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5741
5741
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
5742
5742
|
# @return [Array<(InlineResponse2008, Integer, Hash)>] InlineResponse2008 data, response status code and response headers
|
5743
5743
|
def get_campaign_by_attributes_with_http_info(application_id, body, opts = {})
|
@@ -5876,7 +5876,7 @@ module TalonOne
|
|
5876
5876
|
# @param [Hash] opts the optional parameters
|
5877
5877
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
5878
5878
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5879
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5879
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5880
5880
|
# @return [InlineResponse20013]
|
5881
5881
|
def get_campaign_groups(opts = {})
|
5882
5882
|
data, _status_code, _headers = get_campaign_groups_with_http_info(opts)
|
@@ -5888,7 +5888,7 @@ module TalonOne
|
|
5888
5888
|
# @param [Hash] opts the optional parameters
|
5889
5889
|
# @option opts [Integer] :page_size The number of items in the response.
|
5890
5890
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5891
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5891
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5892
5892
|
# @return [Array<(InlineResponse20013, Integer, Hash)>] InlineResponse20013 data, response status code and response headers
|
5893
5893
|
def get_campaign_groups_with_http_info(opts = {})
|
5894
5894
|
if @api_client.config.debugging
|
@@ -5949,7 +5949,7 @@ module TalonOne
|
|
5949
5949
|
# @param [Hash] opts the optional parameters
|
5950
5950
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
5951
5951
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5952
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5952
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5953
5953
|
# @option opts [String] :state Filter results by the state of the campaign template.
|
5954
5954
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
|
5955
5955
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values.
|
@@ -5965,7 +5965,7 @@ module TalonOne
|
|
5965
5965
|
# @param [Hash] opts the optional parameters
|
5966
5966
|
# @option opts [Integer] :page_size The number of items in the response.
|
5967
5967
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
5968
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
5968
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
5969
5969
|
# @option opts [String] :state Filter results by the state of the campaign template.
|
5970
5970
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
|
5971
5971
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values.
|
@@ -6039,7 +6039,7 @@ module TalonOne
|
|
6039
6039
|
# @param [Hash] opts the optional parameters
|
6040
6040
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
6041
6041
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6042
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
6042
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
6043
6043
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
6044
6044
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
|
6045
6045
|
# @option opts [String] :tags 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
|
@@ -6060,7 +6060,7 @@ module TalonOne
|
|
6060
6060
|
# @param [Hash] opts the optional parameters
|
6061
6061
|
# @option opts [Integer] :page_size The number of items in the response.
|
6062
6062
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6063
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
6063
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
6064
6064
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
6065
6065
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
|
6066
6066
|
# @option opts [String] :tags 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
|
@@ -6145,7 +6145,7 @@ module TalonOne
|
|
6145
6145
|
# @param [Hash] opts the optional parameters
|
6146
6146
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
6147
6147
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6148
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
6148
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
6149
6149
|
# @option opts [Float] :application_id Filter results by Application ID.
|
6150
6150
|
# @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
|
6151
6151
|
# @option opts [Integer] :user_id Filter results by user ID.
|
@@ -6165,7 +6165,7 @@ module TalonOne
|
|
6165
6165
|
# @param [Hash] opts the optional parameters
|
6166
6166
|
# @option opts [Integer] :page_size The number of items in the response.
|
6167
6167
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6168
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
6168
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
6169
6169
|
# @option opts [Float] :application_id Filter results by Application ID.
|
6170
6170
|
# @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
|
6171
6171
|
# @option opts [Integer] :user_id Filter results by user ID.
|
@@ -6394,7 +6394,7 @@ module TalonOne
|
|
6394
6394
|
# @param [Hash] opts the optional parameters
|
6395
6395
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
6396
6396
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6397
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
6397
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
6398
6398
|
# @option opts [String] :value 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.
|
6399
6399
|
# @option opts [DateTime] :created_before 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.
|
6400
6400
|
# @option opts [DateTime] :created_after 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.
|
@@ -6423,7 +6423,7 @@ module TalonOne
|
|
6423
6423
|
# @param [Hash] opts the optional parameters
|
6424
6424
|
# @option opts [Integer] :page_size The number of items in the response.
|
6425
6425
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6426
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
6426
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
6427
6427
|
# @option opts [String] :value 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.
|
6428
6428
|
# @option opts [DateTime] :created_before 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.
|
6429
6429
|
# @option opts [DateTime] :created_after 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.
|
@@ -6633,7 +6633,7 @@ module TalonOne
|
|
6633
6633
|
# @param [Hash] opts the optional parameters
|
6634
6634
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
6635
6635
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6636
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
6636
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
6637
6637
|
# @option opts [String] :name Only return reports matching the customer name.
|
6638
6638
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
6639
6639
|
# @option opts [String] :campaign_name Only return reports matching the campaign name.
|
@@ -6652,7 +6652,7 @@ module TalonOne
|
|
6652
6652
|
# @param [Hash] opts the optional parameters
|
6653
6653
|
# @option opts [Integer] :page_size The number of items in the response.
|
6654
6654
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6655
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
6655
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
6656
6656
|
# @option opts [String] :name Only return reports matching the customer name.
|
6657
6657
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
6658
6658
|
# @option opts [String] :campaign_name Only return reports matching the campaign name.
|
@@ -6737,7 +6737,7 @@ module TalonOne
|
|
6737
6737
|
# @param [Hash] opts the optional parameters
|
6738
6738
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
6739
6739
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6740
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
6740
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
6741
6741
|
# @return [CustomerAnalytics]
|
6742
6742
|
def get_customer_analytics(application_id, customer_id, opts = {})
|
6743
6743
|
data, _status_code, _headers = get_customer_analytics_with_http_info(application_id, customer_id, opts)
|
@@ -6751,7 +6751,7 @@ module TalonOne
|
|
6751
6751
|
# @param [Hash] opts the optional parameters
|
6752
6752
|
# @option opts [Integer] :page_size The number of items in the response.
|
6753
6753
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
6754
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
6754
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
6755
6755
|
# @return [Array<(CustomerAnalytics, Integer, Hash)>] CustomerAnalytics data, response status code and response headers
|
6756
6756
|
def get_customer_analytics_with_http_info(application_id, customer_id, opts = {})
|
6757
6757
|
if @api_client.config.debugging
|
@@ -7205,7 +7205,7 @@ module TalonOne
|
|
7205
7205
|
# @option opts [Boolean] :include_old_versions Include all versions of every event type. (default to false)
|
7206
7206
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
7207
7207
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7208
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
7208
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
7209
7209
|
# @return [InlineResponse20042]
|
7210
7210
|
def get_event_types(opts = {})
|
7211
7211
|
data, _status_code, _headers = get_event_types_with_http_info(opts)
|
@@ -7219,7 +7219,7 @@ module TalonOne
|
|
7219
7219
|
# @option opts [Boolean] :include_old_versions Include all versions of every event type.
|
7220
7220
|
# @option opts [Integer] :page_size The number of items in the response.
|
7221
7221
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7222
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
7222
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
7223
7223
|
# @return [Array<(InlineResponse20042, Integer, Hash)>] InlineResponse20042 data, response status code and response headers
|
7224
7224
|
def get_event_types_with_http_info(opts = {})
|
7225
7225
|
if @api_client.config.debugging
|
@@ -7533,7 +7533,7 @@ module TalonOne
|
|
7533
7533
|
# @param [Hash] opts the optional parameters
|
7534
7534
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
7535
7535
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7536
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
7536
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
7537
7537
|
# @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
|
7538
7538
|
# @option opts [Integer] :profile_id Filter results by customer profile ID.
|
7539
7539
|
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
@@ -7549,7 +7549,7 @@ module TalonOne
|
|
7549
7549
|
# @param [Hash] opts the optional parameters
|
7550
7550
|
# @option opts [Integer] :page_size The number of items in the response.
|
7551
7551
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7552
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
7552
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
7553
7553
|
# @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
|
7554
7554
|
# @option opts [Integer] :profile_id Filter results by customer profile ID.
|
7555
7555
|
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
@@ -7963,6 +7963,121 @@ module TalonOne
|
|
7963
7963
|
return data, status_code, headers
|
7964
7964
|
end
|
7965
7965
|
|
7966
|
+
# List message log entries
|
7967
|
+
# Retrieve all message log entries.
|
7968
|
+
# @param entity_type [String] The entity type the log is related to.
|
7969
|
+
# @param [Hash] opts the optional parameters
|
7970
|
+
# @option opts [String] :message_id Filter results by message ID.
|
7971
|
+
# @option opts [String] :change_type Filter results by change type.
|
7972
|
+
# @option opts [String] :notification_i_ds Filter results by notification ID (include up to 30 values, separated by a comma).
|
7973
|
+
# @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
7974
|
+
# @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
7975
|
+
# @option opts [String] :cursor A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.
|
7976
|
+
# @option opts [String] :period Filter results by time period. Choose between the available relative time frames.
|
7977
|
+
# @option opts [Boolean] :is_successful 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.
|
7978
|
+
# @option opts [Float] :application_id Filter results by Application ID.
|
7979
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
7980
|
+
# @option opts [Integer] :loyalty_program_id Identifier of the loyalty program.
|
7981
|
+
# @option opts [Integer] :response_code Filter results by response status code.
|
7982
|
+
# @option opts [String] :webhook_i_ds Filter results by webhook ID (include up to 30 values, separated by a comma).
|
7983
|
+
# @return [MessageLogEntries]
|
7984
|
+
def get_message_logs(entity_type, opts = {})
|
7985
|
+
data, _status_code, _headers = get_message_logs_with_http_info(entity_type, opts)
|
7986
|
+
data
|
7987
|
+
end
|
7988
|
+
|
7989
|
+
# List message log entries
|
7990
|
+
# Retrieve all message log entries.
|
7991
|
+
# @param entity_type [String] The entity type the log is related to.
|
7992
|
+
# @param [Hash] opts the optional parameters
|
7993
|
+
# @option opts [String] :message_id Filter results by message ID.
|
7994
|
+
# @option opts [String] :change_type Filter results by change type.
|
7995
|
+
# @option opts [String] :notification_i_ds Filter results by notification ID (include up to 30 values, separated by a comma).
|
7996
|
+
# @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
7997
|
+
# @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
7998
|
+
# @option opts [String] :cursor A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.
|
7999
|
+
# @option opts [String] :period Filter results by time period. Choose between the available relative time frames.
|
8000
|
+
# @option opts [Boolean] :is_successful 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.
|
8001
|
+
# @option opts [Float] :application_id Filter results by Application ID.
|
8002
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
8003
|
+
# @option opts [Integer] :loyalty_program_id Identifier of the loyalty program.
|
8004
|
+
# @option opts [Integer] :response_code Filter results by response status code.
|
8005
|
+
# @option opts [String] :webhook_i_ds Filter results by webhook ID (include up to 30 values, separated by a comma).
|
8006
|
+
# @return [Array<(MessageLogEntries, Integer, Hash)>] MessageLogEntries data, response status code and response headers
|
8007
|
+
def get_message_logs_with_http_info(entity_type, opts = {})
|
8008
|
+
if @api_client.config.debugging
|
8009
|
+
@api_client.config.logger.debug 'Calling API: ManagementApi.get_message_logs ...'
|
8010
|
+
end
|
8011
|
+
# verify the required parameter 'entity_type' is set
|
8012
|
+
if @api_client.config.client_side_validation && entity_type.nil?
|
8013
|
+
fail ArgumentError, "Missing the required parameter 'entity_type' when calling ManagementApi.get_message_logs"
|
8014
|
+
end
|
8015
|
+
# verify enum value
|
8016
|
+
allowable_values = ["application", "loyalty_program", "webhook"]
|
8017
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(entity_type)
|
8018
|
+
fail ArgumentError, "invalid value for \"entity_type\", must be one of #{allowable_values}"
|
8019
|
+
end
|
8020
|
+
allowable_values = ["CampaignEvaluationTreeChanged", "CampaignNotification", "CouponCreated", "CouponUpdated", "CouponDeleted", "AsyncCouponsCreated", "CouponsDeleted", "CouponsUpdated", "CouponCodeExpiring", "StrikethroughPrice", "LoyaltyPointsAdded", "LoyaltyPointsDeducted", "LoyaltyPointsExpiring", "LoyaltyPointsPendingToActive", "TierWillDowngrade", "TierUpgrade", "TierDowngrade", "LoyaltyCardPointsAdded", "LoyaltyCardPointsDeducted", "LoyaltyCardPointsExpiring"]
|
8021
|
+
if @api_client.config.client_side_validation && opts[:'change_type'] && !allowable_values.include?(opts[:'change_type'])
|
8022
|
+
fail ArgumentError, "invalid value for \"change_type\", must be one of #{allowable_values}"
|
8023
|
+
end
|
8024
|
+
allowable_values = ["15m", "30m", "1h", "4h", "1d", "2d"]
|
8025
|
+
if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
|
8026
|
+
fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
|
8027
|
+
end
|
8028
|
+
# resource path
|
8029
|
+
local_var_path = '/v1/message_logs'
|
8030
|
+
|
8031
|
+
# query parameters
|
8032
|
+
query_params = opts[:query_params] || {}
|
8033
|
+
query_params[:'entityType'] = entity_type
|
8034
|
+
query_params[:'messageID'] = opts[:'message_id'] if !opts[:'message_id'].nil?
|
8035
|
+
query_params[:'changeType'] = opts[:'change_type'] if !opts[:'change_type'].nil?
|
8036
|
+
query_params[:'notificationIDs'] = opts[:'notification_i_ds'] if !opts[:'notification_i_ds'].nil?
|
8037
|
+
query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
|
8038
|
+
query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
|
8039
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
8040
|
+
query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
|
8041
|
+
query_params[:'isSuccessful'] = opts[:'is_successful'] if !opts[:'is_successful'].nil?
|
8042
|
+
query_params[:'applicationId'] = opts[:'application_id'] if !opts[:'application_id'].nil?
|
8043
|
+
query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
|
8044
|
+
query_params[:'loyaltyProgramId'] = opts[:'loyalty_program_id'] if !opts[:'loyalty_program_id'].nil?
|
8045
|
+
query_params[:'responseCode'] = opts[:'response_code'] if !opts[:'response_code'].nil?
|
8046
|
+
query_params[:'webhookIDs'] = opts[:'webhook_i_ds'] if !opts[:'webhook_i_ds'].nil?
|
8047
|
+
|
8048
|
+
# header parameters
|
8049
|
+
header_params = opts[:header_params] || {}
|
8050
|
+
# HTTP header 'Accept' (if needed)
|
8051
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
8052
|
+
|
8053
|
+
# form parameters
|
8054
|
+
form_params = opts[:form_params] || {}
|
8055
|
+
|
8056
|
+
# http body (model)
|
8057
|
+
post_body = opts[:body]
|
8058
|
+
|
8059
|
+
# return_type
|
8060
|
+
return_type = opts[:return_type] || 'MessageLogEntries'
|
8061
|
+
|
8062
|
+
# auth_names
|
8063
|
+
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
8064
|
+
|
8065
|
+
new_options = opts.merge(
|
8066
|
+
:header_params => header_params,
|
8067
|
+
:query_params => query_params,
|
8068
|
+
:form_params => form_params,
|
8069
|
+
:body => post_body,
|
8070
|
+
:auth_names => auth_names,
|
8071
|
+
:return_type => return_type
|
8072
|
+
)
|
8073
|
+
|
8074
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
8075
|
+
if @api_client.config.debugging
|
8076
|
+
@api_client.config.logger.debug "API called: ManagementApi#get_message_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
8077
|
+
end
|
8078
|
+
return data, status_code, headers
|
8079
|
+
end
|
8080
|
+
|
7966
8081
|
# List referrals
|
7967
8082
|
# List all referrals of the specified campaign.
|
7968
8083
|
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
@@ -7970,7 +8085,7 @@ module TalonOne
|
|
7970
8085
|
# @param [Hash] opts the optional parameters
|
7971
8086
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
7972
8087
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7973
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
8088
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
7974
8089
|
# @option opts [String] :code 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.
|
7975
8090
|
# @option opts [DateTime] :created_before 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.
|
7976
8091
|
# @option opts [DateTime] :created_after 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.
|
@@ -7990,7 +8105,7 @@ module TalonOne
|
|
7990
8105
|
# @param [Hash] opts the optional parameters
|
7991
8106
|
# @option opts [Integer] :page_size The number of items in the response.
|
7992
8107
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
7993
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
8108
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
7994
8109
|
# @option opts [String] :code 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.
|
7995
8110
|
# @option opts [DateTime] :created_before 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.
|
7996
8111
|
# @option opts [DateTime] :created_after 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.
|
@@ -8217,7 +8332,7 @@ module TalonOne
|
|
8217
8332
|
# @param [Hash] opts the optional parameters
|
8218
8333
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
8219
8334
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8220
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
8335
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
8221
8336
|
# @return [InlineResponse2009]
|
8222
8337
|
def get_rulesets(application_id, campaign_id, opts = {})
|
8223
8338
|
data, _status_code, _headers = get_rulesets_with_http_info(application_id, campaign_id, opts)
|
@@ -8231,7 +8346,7 @@ module TalonOne
|
|
8231
8346
|
# @param [Hash] opts the optional parameters
|
8232
8347
|
# @option opts [Integer] :page_size The number of items in the response.
|
8233
8348
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8234
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
8349
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
8235
8350
|
# @return [Array<(InlineResponse2009, Integer, Hash)>] InlineResponse2009 data, response status code and response headers
|
8236
8351
|
def get_rulesets_with_http_info(application_id, campaign_id, opts = {})
|
8237
8352
|
if @api_client.config.debugging
|
@@ -8430,7 +8545,7 @@ module TalonOne
|
|
8430
8545
|
# @param [Hash] opts the optional parameters
|
8431
8546
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
8432
8547
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8433
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
8548
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
8434
8549
|
# @return [InlineResponse20043]
|
8435
8550
|
def get_users(opts = {})
|
8436
8551
|
data, _status_code, _headers = get_users_with_http_info(opts)
|
@@ -8442,7 +8557,7 @@ module TalonOne
|
|
8442
8557
|
# @param [Hash] opts the optional parameters
|
8443
8558
|
# @option opts [Integer] :page_size The number of items in the response.
|
8444
8559
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8445
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
8560
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
8446
8561
|
# @return [Array<(InlineResponse20043, Integer, Hash)>] InlineResponse20043 data, response status code and response headers
|
8447
8562
|
def get_users_with_http_info(opts = {})
|
8448
8563
|
if @api_client.config.debugging
|
@@ -8565,7 +8680,7 @@ module TalonOne
|
|
8565
8680
|
# @param [Hash] opts the optional parameters
|
8566
8681
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
8567
8682
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8568
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
8683
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
8569
8684
|
# @option opts [String] :integration_request_uuid Filter results by integration request UUID.
|
8570
8685
|
# @option opts [Float] :webhook_id Filter results by webhook id.
|
8571
8686
|
# @option opts [Float] :application_id Filter results by Application ID.
|
@@ -8583,7 +8698,7 @@ module TalonOne
|
|
8583
8698
|
# @param [Hash] opts the optional parameters
|
8584
8699
|
# @option opts [Integer] :page_size The number of items in the response.
|
8585
8700
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8586
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
8701
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
8587
8702
|
# @option opts [String] :integration_request_uuid Filter results by integration request UUID.
|
8588
8703
|
# @option opts [Float] :webhook_id Filter results by webhook id.
|
8589
8704
|
# @option opts [Float] :application_id Filter results by Application ID.
|
@@ -8656,7 +8771,7 @@ module TalonOne
|
|
8656
8771
|
# @param [Hash] opts the optional parameters
|
8657
8772
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
8658
8773
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8659
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
8774
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
8660
8775
|
# @option opts [String] :status Filter results by HTTP status codes.
|
8661
8776
|
# @option opts [Float] :webhook_id Filter results by webhook id.
|
8662
8777
|
# @option opts [Float] :application_id Filter results by Application ID.
|
@@ -8675,7 +8790,7 @@ module TalonOne
|
|
8675
8790
|
# @param [Hash] opts the optional parameters
|
8676
8791
|
# @option opts [Integer] :page_size The number of items in the response.
|
8677
8792
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8678
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
8793
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
8679
8794
|
# @option opts [String] :status Filter results by HTTP status codes.
|
8680
8795
|
# @option opts [Float] :webhook_id Filter results by webhook id.
|
8681
8796
|
# @option opts [Float] :application_id Filter results by Application ID.
|
@@ -8753,7 +8868,7 @@ module TalonOne
|
|
8753
8868
|
# List all webhooks.
|
8754
8869
|
# @param [Hash] opts the optional parameters
|
8755
8870
|
# @option opts [String] :application_ids 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.
|
8756
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
8871
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
8757
8872
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
8758
8873
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8759
8874
|
# @option opts [String] :creation_type Filter results by creation type.
|
@@ -8770,7 +8885,7 @@ module TalonOne
|
|
8770
8885
|
# List all webhooks.
|
8771
8886
|
# @param [Hash] opts the optional parameters
|
8772
8887
|
# @option opts [String] :application_ids 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.
|
8773
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
8888
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
8774
8889
|
# @option opts [Integer] :page_size The number of items in the response.
|
8775
8890
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
8776
8891
|
# @option opts [String] :creation_type Filter results by creation type.
|
@@ -9682,7 +9797,7 @@ module TalonOne
|
|
9682
9797
|
# @param [Hash] opts the optional parameters
|
9683
9798
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
9684
9799
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
9685
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
9800
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
9686
9801
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
9687
9802
|
# @option opts [String] :name Filter by collection name.
|
9688
9803
|
# @return [InlineResponse20020]
|
@@ -9696,7 +9811,7 @@ module TalonOne
|
|
9696
9811
|
# @param [Hash] opts the optional parameters
|
9697
9812
|
# @option opts [Integer] :page_size The number of items in the response.
|
9698
9813
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
9699
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
9814
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
9700
9815
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
9701
9816
|
# @option opts [String] :name Filter by collection name.
|
9702
9817
|
# @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
|
@@ -9989,7 +10104,7 @@ module TalonOne
|
|
9989
10104
|
# @param [Hash] opts the optional parameters
|
9990
10105
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
9991
10106
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
9992
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
10107
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
9993
10108
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
9994
10109
|
# @option opts [String] :name Filter by collection name.
|
9995
10110
|
# @return [InlineResponse20020]
|
@@ -10005,7 +10120,7 @@ module TalonOne
|
|
10005
10120
|
# @param [Hash] opts the optional parameters
|
10006
10121
|
# @option opts [Integer] :page_size The number of items in the response.
|
10007
10122
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
10008
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
10123
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
10009
10124
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
10010
10125
|
# @option opts [String] :name Filter by collection name.
|
10011
10126
|
# @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
|
@@ -10079,7 +10194,7 @@ module TalonOne
|
|
10079
10194
|
# @param [Hash] opts the optional parameters
|
10080
10195
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
10081
10196
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
10082
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
10197
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
10083
10198
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
10084
10199
|
# @option opts [String] :name Filter by collection name.
|
10085
10200
|
# @return [InlineResponse20020]
|
@@ -10094,7 +10209,7 @@ module TalonOne
|
|
10094
10209
|
# @param [Hash] opts the optional parameters
|
10095
10210
|
# @option opts [Integer] :page_size The number of items in the response.
|
10096
10211
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
10097
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
10212
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
10098
10213
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
10099
10214
|
# @option opts [String] :name Filter by collection name.
|
10100
10215
|
# @return [Array<(InlineResponse20020, Integer, Hash)>] InlineResponse20020 data, response status code and response headers
|
@@ -10164,7 +10279,7 @@ module TalonOne
|
|
10164
10279
|
# @param [Hash] opts the optional parameters
|
10165
10280
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
10166
10281
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
10167
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
10282
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
10168
10283
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
10169
10284
|
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
10170
10285
|
# @option opts [String] :name The name of the store.
|
@@ -10182,7 +10297,7 @@ module TalonOne
|
|
10182
10297
|
# @param [Hash] opts the optional parameters
|
10183
10298
|
# @option opts [Integer] :page_size The number of items in the response.
|
10184
10299
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
10185
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
10300
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
10186
10301
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
10187
10302
|
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
10188
10303
|
# @option opts [String] :name The name of the store.
|
@@ -10252,74 +10367,6 @@ module TalonOne
|
|
10252
10367
|
return data, status_code, headers
|
10253
10368
|
end
|
10254
10369
|
|
10255
|
-
# Activate or deactivate notification
|
10256
|
-
# Activate or deactivate the given notification. When `enabled` is false, updates will no longer be sent for the given notification.
|
10257
|
-
# @param notification_id [Integer] The ID of the notification. Get it with the appropriate _List notifications_ endpoint.
|
10258
|
-
# @param body [NotificationActivation] body
|
10259
|
-
# @param [Hash] opts the optional parameters
|
10260
|
-
# @return [nil]
|
10261
|
-
def notification_activation(notification_id, body, opts = {})
|
10262
|
-
notification_activation_with_http_info(notification_id, body, opts)
|
10263
|
-
nil
|
10264
|
-
end
|
10265
|
-
|
10266
|
-
# Activate or deactivate notification
|
10267
|
-
# Activate or deactivate the given notification. When `enabled` is false, updates will no longer be sent for the given notification.
|
10268
|
-
# @param notification_id [Integer] The ID of the notification. Get it with the appropriate _List notifications_ endpoint.
|
10269
|
-
# @param body [NotificationActivation] body
|
10270
|
-
# @param [Hash] opts the optional parameters
|
10271
|
-
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
10272
|
-
def notification_activation_with_http_info(notification_id, body, opts = {})
|
10273
|
-
if @api_client.config.debugging
|
10274
|
-
@api_client.config.logger.debug 'Calling API: ManagementApi.notification_activation ...'
|
10275
|
-
end
|
10276
|
-
# verify the required parameter 'notification_id' is set
|
10277
|
-
if @api_client.config.client_side_validation && notification_id.nil?
|
10278
|
-
fail ArgumentError, "Missing the required parameter 'notification_id' when calling ManagementApi.notification_activation"
|
10279
|
-
end
|
10280
|
-
# verify the required parameter 'body' is set
|
10281
|
-
if @api_client.config.client_side_validation && body.nil?
|
10282
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.notification_activation"
|
10283
|
-
end
|
10284
|
-
# resource path
|
10285
|
-
local_var_path = '/v1/notifications/{notificationId}/activation'.sub('{' + 'notificationId' + '}', CGI.escape(notification_id.to_s))
|
10286
|
-
|
10287
|
-
# query parameters
|
10288
|
-
query_params = opts[:query_params] || {}
|
10289
|
-
|
10290
|
-
# header parameters
|
10291
|
-
header_params = opts[:header_params] || {}
|
10292
|
-
# HTTP header 'Content-Type'
|
10293
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
10294
|
-
|
10295
|
-
# form parameters
|
10296
|
-
form_params = opts[:form_params] || {}
|
10297
|
-
|
10298
|
-
# http body (model)
|
10299
|
-
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
10300
|
-
|
10301
|
-
# return_type
|
10302
|
-
return_type = opts[:return_type]
|
10303
|
-
|
10304
|
-
# auth_names
|
10305
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
10306
|
-
|
10307
|
-
new_options = opts.merge(
|
10308
|
-
:header_params => header_params,
|
10309
|
-
:query_params => query_params,
|
10310
|
-
:form_params => form_params,
|
10311
|
-
:body => post_body,
|
10312
|
-
:auth_names => auth_names,
|
10313
|
-
:return_type => return_type
|
10314
|
-
)
|
10315
|
-
|
10316
|
-
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
10317
|
-
if @api_client.config.debugging
|
10318
|
-
@api_client.config.logger.debug "API called: ManagementApi#notification_activation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10319
|
-
end
|
10320
|
-
return data, status_code, headers
|
10321
|
-
end
|
10322
|
-
|
10323
10370
|
# Validate Okta API ownership
|
10324
10371
|
# Validate the ownership of the API through a challenge-response mechanism. This challenger endpoint is used by Okta to confirm that communication between Talon.One and Okta is correctly configured and accessible for provisioning and deprovisioning of Talon.One users, and that only Talon.One can receive and respond to events from Okta.
|
10325
10372
|
# @param [Hash] opts the optional parameters
|
@@ -10374,216 +10421,6 @@ module TalonOne
|
|
10374
10421
|
return data, status_code, headers
|
10375
10422
|
end
|
10376
10423
|
|
10377
|
-
# Create notification about added or deducted loyalty points
|
10378
|
-
# 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).
|
10379
|
-
# @param 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.
|
10380
|
-
# @param body [NewBaseNotification] body
|
10381
|
-
# @param [Hash] opts the optional parameters
|
10382
|
-
# @return [BaseNotification]
|
10383
|
-
def post_added_deducted_points_notification(loyalty_program_id, body, opts = {})
|
10384
|
-
data, _status_code, _headers = post_added_deducted_points_notification_with_http_info(loyalty_program_id, body, opts)
|
10385
|
-
data
|
10386
|
-
end
|
10387
|
-
|
10388
|
-
# Create notification about added or deducted loyalty points
|
10389
|
-
# 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).
|
10390
|
-
# @param 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.
|
10391
|
-
# @param body [NewBaseNotification] body
|
10392
|
-
# @param [Hash] opts the optional parameters
|
10393
|
-
# @return [Array<(BaseNotification, Integer, Hash)>] BaseNotification data, response status code and response headers
|
10394
|
-
def post_added_deducted_points_notification_with_http_info(loyalty_program_id, body, opts = {})
|
10395
|
-
if @api_client.config.debugging
|
10396
|
-
@api_client.config.logger.debug 'Calling API: ManagementApi.post_added_deducted_points_notification ...'
|
10397
|
-
end
|
10398
|
-
# verify the required parameter 'loyalty_program_id' is set
|
10399
|
-
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
10400
|
-
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.post_added_deducted_points_notification"
|
10401
|
-
end
|
10402
|
-
# verify the required parameter 'body' is set
|
10403
|
-
if @api_client.config.client_side_validation && body.nil?
|
10404
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.post_added_deducted_points_notification"
|
10405
|
-
end
|
10406
|
-
# resource path
|
10407
|
-
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))
|
10408
|
-
|
10409
|
-
# query parameters
|
10410
|
-
query_params = opts[:query_params] || {}
|
10411
|
-
|
10412
|
-
# header parameters
|
10413
|
-
header_params = opts[:header_params] || {}
|
10414
|
-
# HTTP header 'Accept' (if needed)
|
10415
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
10416
|
-
# HTTP header 'Content-Type'
|
10417
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
10418
|
-
|
10419
|
-
# form parameters
|
10420
|
-
form_params = opts[:form_params] || {}
|
10421
|
-
|
10422
|
-
# http body (model)
|
10423
|
-
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
10424
|
-
|
10425
|
-
# return_type
|
10426
|
-
return_type = opts[:return_type] || 'BaseNotification'
|
10427
|
-
|
10428
|
-
# auth_names
|
10429
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
10430
|
-
|
10431
|
-
new_options = opts.merge(
|
10432
|
-
:header_params => header_params,
|
10433
|
-
:query_params => query_params,
|
10434
|
-
:form_params => form_params,
|
10435
|
-
:body => post_body,
|
10436
|
-
:auth_names => auth_names,
|
10437
|
-
:return_type => return_type
|
10438
|
-
)
|
10439
|
-
|
10440
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
10441
|
-
if @api_client.config.debugging
|
10442
|
-
@api_client.config.logger.debug "API called: ManagementApi#post_added_deducted_points_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10443
|
-
end
|
10444
|
-
return data, status_code, headers
|
10445
|
-
end
|
10446
|
-
|
10447
|
-
# Create strikethrough notification
|
10448
|
-
# 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.
|
10449
|
-
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
10450
|
-
# @param body [NewBaseNotification] body
|
10451
|
-
# @param [Hash] opts the optional parameters
|
10452
|
-
# @return [BaseNotification]
|
10453
|
-
def post_catalogs_strikethrough_notification(application_id, body, opts = {})
|
10454
|
-
data, _status_code, _headers = post_catalogs_strikethrough_notification_with_http_info(application_id, body, opts)
|
10455
|
-
data
|
10456
|
-
end
|
10457
|
-
|
10458
|
-
# Create strikethrough notification
|
10459
|
-
# 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.
|
10460
|
-
# @param application_id [Integer] The ID of the Application. It is displayed in your Talon.One deployment URL.
|
10461
|
-
# @param body [NewBaseNotification] body
|
10462
|
-
# @param [Hash] opts the optional parameters
|
10463
|
-
# @return [Array<(BaseNotification, Integer, Hash)>] BaseNotification data, response status code and response headers
|
10464
|
-
def post_catalogs_strikethrough_notification_with_http_info(application_id, body, opts = {})
|
10465
|
-
if @api_client.config.debugging
|
10466
|
-
@api_client.config.logger.debug 'Calling API: ManagementApi.post_catalogs_strikethrough_notification ...'
|
10467
|
-
end
|
10468
|
-
# verify the required parameter 'application_id' is set
|
10469
|
-
if @api_client.config.client_side_validation && application_id.nil?
|
10470
|
-
fail ArgumentError, "Missing the required parameter 'application_id' when calling ManagementApi.post_catalogs_strikethrough_notification"
|
10471
|
-
end
|
10472
|
-
# verify the required parameter 'body' is set
|
10473
|
-
if @api_client.config.client_side_validation && body.nil?
|
10474
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.post_catalogs_strikethrough_notification"
|
10475
|
-
end
|
10476
|
-
# resource path
|
10477
|
-
local_var_path = '/v1/applications/{applicationId}/catalogs/notifications/strikethrough'.sub('{' + 'applicationId' + '}', CGI.escape(application_id.to_s))
|
10478
|
-
|
10479
|
-
# query parameters
|
10480
|
-
query_params = opts[:query_params] || {}
|
10481
|
-
|
10482
|
-
# header parameters
|
10483
|
-
header_params = opts[:header_params] || {}
|
10484
|
-
# HTTP header 'Accept' (if needed)
|
10485
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
10486
|
-
# HTTP header 'Content-Type'
|
10487
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
10488
|
-
|
10489
|
-
# form parameters
|
10490
|
-
form_params = opts[:form_params] || {}
|
10491
|
-
|
10492
|
-
# http body (model)
|
10493
|
-
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
10494
|
-
|
10495
|
-
# return_type
|
10496
|
-
return_type = opts[:return_type] || 'BaseNotification'
|
10497
|
-
|
10498
|
-
# auth_names
|
10499
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
10500
|
-
|
10501
|
-
new_options = opts.merge(
|
10502
|
-
:header_params => header_params,
|
10503
|
-
:query_params => query_params,
|
10504
|
-
:form_params => form_params,
|
10505
|
-
:body => post_body,
|
10506
|
-
:auth_names => auth_names,
|
10507
|
-
:return_type => return_type
|
10508
|
-
)
|
10509
|
-
|
10510
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
10511
|
-
if @api_client.config.debugging
|
10512
|
-
@api_client.config.logger.debug "API called: ManagementApi#post_catalogs_strikethrough_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10513
|
-
end
|
10514
|
-
return data, status_code, headers
|
10515
|
-
end
|
10516
|
-
|
10517
|
-
# Create notification about pending loyalty points
|
10518
|
-
# 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).
|
10519
|
-
# @param 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.
|
10520
|
-
# @param body [NewBaseNotification] body
|
10521
|
-
# @param [Hash] opts the optional parameters
|
10522
|
-
# @return [BaseNotification]
|
10523
|
-
def post_pending_points_notification(loyalty_program_id, body, opts = {})
|
10524
|
-
data, _status_code, _headers = post_pending_points_notification_with_http_info(loyalty_program_id, body, opts)
|
10525
|
-
data
|
10526
|
-
end
|
10527
|
-
|
10528
|
-
# Create notification about pending loyalty points
|
10529
|
-
# 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).
|
10530
|
-
# @param 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.
|
10531
|
-
# @param body [NewBaseNotification] body
|
10532
|
-
# @param [Hash] opts the optional parameters
|
10533
|
-
# @return [Array<(BaseNotification, Integer, Hash)>] BaseNotification data, response status code and response headers
|
10534
|
-
def post_pending_points_notification_with_http_info(loyalty_program_id, body, opts = {})
|
10535
|
-
if @api_client.config.debugging
|
10536
|
-
@api_client.config.logger.debug 'Calling API: ManagementApi.post_pending_points_notification ...'
|
10537
|
-
end
|
10538
|
-
# verify the required parameter 'loyalty_program_id' is set
|
10539
|
-
if @api_client.config.client_side_validation && loyalty_program_id.nil?
|
10540
|
-
fail ArgumentError, "Missing the required parameter 'loyalty_program_id' when calling ManagementApi.post_pending_points_notification"
|
10541
|
-
end
|
10542
|
-
# verify the required parameter 'body' is set
|
10543
|
-
if @api_client.config.client_side_validation && body.nil?
|
10544
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling ManagementApi.post_pending_points_notification"
|
10545
|
-
end
|
10546
|
-
# resource path
|
10547
|
-
local_var_path = '/v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points'.sub('{' + 'loyaltyProgramId' + '}', CGI.escape(loyalty_program_id.to_s))
|
10548
|
-
|
10549
|
-
# query parameters
|
10550
|
-
query_params = opts[:query_params] || {}
|
10551
|
-
|
10552
|
-
# header parameters
|
10553
|
-
header_params = opts[:header_params] || {}
|
10554
|
-
# HTTP header 'Accept' (if needed)
|
10555
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
10556
|
-
# HTTP header 'Content-Type'
|
10557
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
10558
|
-
|
10559
|
-
# form parameters
|
10560
|
-
form_params = opts[:form_params] || {}
|
10561
|
-
|
10562
|
-
# http body (model)
|
10563
|
-
post_body = opts[:body] || @api_client.object_to_http_body(body)
|
10564
|
-
|
10565
|
-
# return_type
|
10566
|
-
return_type = opts[:return_type] || 'BaseNotification'
|
10567
|
-
|
10568
|
-
# auth_names
|
10569
|
-
auth_names = opts[:auth_names] || ['management_key', 'manager_auth']
|
10570
|
-
|
10571
|
-
new_options = opts.merge(
|
10572
|
-
:header_params => header_params,
|
10573
|
-
:query_params => query_params,
|
10574
|
-
:form_params => form_params,
|
10575
|
-
:body => post_body,
|
10576
|
-
:auth_names => auth_names,
|
10577
|
-
:return_type => return_type
|
10578
|
-
)
|
10579
|
-
|
10580
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
10581
|
-
if @api_client.config.debugging
|
10582
|
-
@api_client.config.logger.debug "API called: ManagementApi#post_pending_points_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
10583
|
-
end
|
10584
|
-
return data, status_code, headers
|
10585
|
-
end
|
10586
|
-
|
10587
10424
|
# Deduct points from customer profile
|
10588
10425
|
# Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
10589
10426
|
# @param loyalty_program_id [String] The identifier for the loyalty program.
|
@@ -11281,7 +11118,7 @@ module TalonOne
|
|
11281
11118
|
# @param [Hash] opts the optional parameters
|
11282
11119
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
11283
11120
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
11284
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
11121
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
11285
11122
|
# @option opts [String] :value 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.
|
11286
11123
|
# @option opts [DateTime] :created_before 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.
|
11287
11124
|
# @option opts [DateTime] :created_after 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.
|
@@ -11305,7 +11142,7 @@ module TalonOne
|
|
11305
11142
|
# @param [Hash] opts the optional parameters
|
11306
11143
|
# @option opts [Integer] :page_size The number of items in the response.
|
11307
11144
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
11308
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
11145
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
11309
11146
|
# @option opts [String] :value 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.
|
11310
11147
|
# @option opts [DateTime] :created_before 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.
|
11311
11148
|
# @option opts [DateTime] :created_after 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.
|
@@ -11411,7 +11248,7 @@ module TalonOne
|
|
11411
11248
|
# @param [Hash] opts the optional parameters
|
11412
11249
|
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
11413
11250
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
11414
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
11251
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
11415
11252
|
# @option opts [String] :value 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.
|
11416
11253
|
# @option opts [DateTime] :created_before 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.
|
11417
11254
|
# @option opts [DateTime] :created_after 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.
|
@@ -11435,7 +11272,7 @@ module TalonOne
|
|
11435
11272
|
# @param [Hash] opts the optional parameters
|
11436
11273
|
# @option opts [Integer] :page_size The number of items in the response.
|
11437
11274
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
11438
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
11275
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
11439
11276
|
# @option opts [String] :value 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.
|
11440
11277
|
# @option opts [DateTime] :created_before 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.
|
11441
11278
|
# @option opts [DateTime] :created_after 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.
|