talon_one_sdk 26.01 → 26.02

data/docs/ManagementApi.md

@@ -59,6 +59,7 @@ All URIs are relative to *https://yourbaseurl.talon.one*
 | [**export_loyalty_ledger**](ManagementApi.md#export_loyalty_ledger) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export customer's transaction logs |
 | [**export_pool_giveaways**](ManagementApi.md#export_pool_giveaways) | **GET** /v1/giveaways/pools/{poolId}/export | Export giveaway codes of a giveaway pool |
 | [**export_referrals**](ManagementApi.md#export_referrals) | **GET** /v1/applications/{applicationId}/export_referrals | Export referrals |
+| [**generate_coupon_rejections**](ManagementApi.md#generate_coupon_rejections) | **GET** /v1/coupon_rejections | Summarize coupon redemption failures in session |
 | [**get_access_logs_without_total_count**](ManagementApi.md#get_access_logs_without_total_count) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for Application |
 | [**get_account**](ManagementApi.md#get_account) | **GET** /v1/accounts/{accountId} | Get account details |
 | [**get_account_analytics**](ManagementApi.md#get_account_analytics) | **GET** /v1/accounts/{accountId}/analytics | Get account analytics |
@@ -106,8 +107,10 @@ All URIs are relative to *https://yourbaseurl.talon.one*
 | [**get_loyalty_card**](ManagementApi.md#get_loyalty_card) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Get loyalty card |
 | [**get_loyalty_card_transaction_logs**](ManagementApi.md#get_loyalty_card_transaction_logs) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/logs | List card's transactions |
 | [**get_loyalty_cards**](ManagementApi.md#get_loyalty_cards) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards | List loyalty cards |
+| [**get_loyalty_ledger_balances**](ManagementApi.md#get_loyalty_ledger_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_balances | Get customer's loyalty balances |
 | [**get_loyalty_points**](ManagementApi.md#get_loyalty_points) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId} | Get customer's full loyalty ledger |
 | [**get_loyalty_program**](ManagementApi.md#get_loyalty_program) | **GET** /v1/loyalty_programs/{loyaltyProgramId} | Get loyalty program |
+| [**get_loyalty_program_profile_ledger_transactions**](ManagementApi.md#get_loyalty_program_profile_ledger_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/ledger_transactions | List customer's loyalty transactions |
 | [**get_loyalty_program_transactions**](ManagementApi.md#get_loyalty_program_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/transactions | List loyalty program transactions |
 | [**get_loyalty_programs**](ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List loyalty programs |
 | [**get_loyalty_statistics**](ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics |
@@ -4871,6 +4874,95 @@ end
 - **Accept**: application/csv
 
 
+## generate_coupon_rejections
+
+> <GenerateCouponRejections200Response> generate_coupon_rejections(session_integration_id, opts)
+
+Summarize coupon redemption failures in session
+
+Create a summary of the reasons for coupon redemption failures in a given customer session. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'talon_one_sdk'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: management_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+
+  # Configure API key authorization: manager_auth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+
+  # Configure API key authorization: api_key_v1
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TalonOne::ManagementApi.new
+session_integration_id = 'session_integration_id_example' # String | The integration ID of the session to summarize.
+opts = {
+  application_id: 8.14, # Float | Filter results by Application ID.
+  language: 'language_example', # String | The [ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) code of the language in which the summary will be generated. 
+  coupon_code: 'coupon_code_example' # String | The coupon code for which to get the rejection reason.
+}
+
+begin
+  # Summarize coupon redemption failures in session
+  result = api_instance.generate_coupon_rejections(session_integration_id, opts)
+  p result
+rescue TalonOne::ApiError => e
+  puts "Error when calling ManagementApi->generate_coupon_rejections: #{e}"
+end
+```
+
+#### Using the generate_coupon_rejections_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GenerateCouponRejections200Response>, Integer, Hash)> generate_coupon_rejections_with_http_info(session_integration_id, opts)
+
+```ruby
+begin
+  # Summarize coupon redemption failures in session
+  data, status_code, headers = api_instance.generate_coupon_rejections_with_http_info(session_integration_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GenerateCouponRejections200Response>
+rescue TalonOne::ApiError => e
+  puts "Error when calling ManagementApi->generate_coupon_rejections_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session_integration_id** | **String** | The integration ID of the session to summarize. |  |
+| **application_id** | **Float** | Filter results by Application ID. | [optional] |
+| **language** | **String** | The [ISO-639](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) code of the language in which the summary will be generated.  | [optional] |
+| **coupon_code** | **String** | The coupon code for which to get the rejection reason. | [optional] |
+
+### Return type
+
+[**GenerateCouponRejections200Response**](GenerateCouponRejections200Response.md)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_access_logs_without_total_count
 
 > <GetAccessLogsWithoutTotalCount200Response> get_access_logs_without_total_count(application_id, range_start, range_end, opts)
@@ -9128,6 +9220,99 @@ end
 - **Accept**: application/json
 
 
+## get_loyalty_ledger_balances
+
+> <LoyaltyBalancesWithTiers> get_loyalty_ledger_balances(loyalty_program_id, integration_id, opts)
+
+Get customer's loyalty balances
+
+Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. You can filter balances by date and subledger ID, and include tier-related information in the response.  **Note**: If no filtering options are applied, you retrieve all loyalty balances on the current date for the given integration ID.  Loyalty balances are calculated when Talon.One receives your request using the points stored in our database, so retrieving a large number of balances at once can impact performance.  For more information, see: - [Managing card-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/card-based/managing-loyalty-cards) - [Managing profile-based loyalty program data](https://docs.talon.one/docs/product/loyalty-programs/profile-based/managing-pb-lp-data) 
+
+### Examples
+
+```ruby
+require 'time'
+require 'talon_one_sdk'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: management_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+
+  # Configure API key authorization: manager_auth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+
+  # Configure API key authorization: api_key_v1
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TalonOne::ManagementApi.new
+loyalty_program_id = 789 # 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. 
+integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.  Once set, you cannot update this identifier. 
+opts = {
+  end_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value.  **Note:**  - It 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. 
+  subledger_id: 'subledger_id_example', # String | The ID of the subledger used to filter the data. Leave this value empty (\"\") to query the main ledger.
+  include_tiers: true, # Boolean | Indicates whether tier information is included in the response.  When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. 
+  include_projected_tier: true # Boolean | Indicates whether the customer's projected tier information is included in the response.  When set to `true`, the response includes information about the customer's active points and the name of the projected tier.  **Note** We recommend filtering by `subledgerId` for better performance. 
+}
+
+begin
+  # Get customer's loyalty balances
+  result = api_instance.get_loyalty_ledger_balances(loyalty_program_id, integration_id, opts)
+  p result
+rescue TalonOne::ApiError => e
+  puts "Error when calling ManagementApi->get_loyalty_ledger_balances: #{e}"
+end
+```
+
+#### Using the get_loyalty_ledger_balances_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LoyaltyBalancesWithTiers>, Integer, Hash)> get_loyalty_ledger_balances_with_http_info(loyalty_program_id, integration_id, opts)
+
+```ruby
+begin
+  # Get customer's loyalty balances
+  data, status_code, headers = api_instance.get_loyalty_ledger_balances_with_http_info(loyalty_program_id, integration_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LoyaltyBalancesWithTiers>
+rescue TalonOne::ApiError => e
+  puts "Error when calling ManagementApi->get_loyalty_ledger_balances_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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.  |  |
+| **integration_id** | **String** | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.  Once set, you cannot update this identifier.  |  |
+| **end_date** | **Time** | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value.  **Note:**  - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.  | [optional] |
+| **subledger_id** | **String** | The ID of the subledger used to filter the data. Leave this value empty (\&quot;\&quot;) to query the main ledger. | [optional] |
+| **include_tiers** | **Boolean** | Indicates whether tier information is included in the response.  When set to &#x60;true&#x60;, the response includes information about the current tier and the number of points required to move to next tier.  | [optional][default to false] |
+| **include_projected_tier** | **Boolean** | Indicates whether the customer&#39;s projected tier information is included in the response.  When set to &#x60;true&#x60;, the response includes information about the customer&#39;s active points and the name of the projected tier.  **Note** We recommend filtering by &#x60;subledgerId&#x60; for better performance.  | [optional][default to false] |
+
+### Return type
+
+[**LoyaltyBalancesWithTiers**](LoyaltyBalancesWithTiers.md)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_loyalty_points
 
 > <LoyaltyLedger> get_loyalty_points(loyalty_program_id, integration_id)
@@ -9292,6 +9477,109 @@ end
 - **Accept**: application/json
 
 
+## get_loyalty_program_profile_ledger_transactions
+
+> <GetLoyaltyProgramProfileTransactions200Response> get_loyalty_program_profile_ledger_transactions(loyalty_program_id, integration_id, opts)
+
+List customer's loyalty transactions
+
+Retrieve paginated results of loyalty transaction logs for the given Integration ID in the specified loyalty program.  You can filter transactions by date or by ledger (subledger or main ledger). If no filters are applied, the last 50 loyalty transactions for the given integration ID are returned.  **Note:** To retrieve all loyalty program transaction logs in a given loyalty program, use the [List loyalty program transactions](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgramTransactions) endpoint. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'talon_one_sdk'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: management_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+
+  # Configure API key authorization: manager_auth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+
+  # Configure API key authorization: api_key_v1
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TalonOne::ManagementApi.new
+loyalty_program_id = 789 # 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. 
+integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.  Once set, you cannot update this identifier. 
+opts = {
+  customer_session_ids: ['inner_example'], # Array<String> | Filter the results by a list of customer session IDs.   To include multiple IDs, repeat the parameter for each one, for example,  `?customerSessionIDs=id1&customerSessionIDs=id2`.  The response contains only data associated with the specified sessions. 
+  transaction_uuids: ['inner_example'], # Array<String> | Filter the results by a list of transaction UUIDs.  To include multiple IDs, repeat the parameter for each one, for example,  `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`.  The response contains only data associated with the specified transactions. 
+  subledger_id: 'subledger_id_example', # String | The ID of the subledger used to filter the data. Leave this value empty (\"\") to query the main ledger.
+  loyalty_transaction_type: 'manual', # String | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. 
+  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Date and time from which results are returned. Results are filtered by transaction creation date.  **Note:**  - It 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. 
+  end_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Date and time by which results are returned. Results are filtered by transaction creation date.  **Note:**  - It 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. 
+  page_size: 789, # Integer | The number of items in the response.
+  skip: 789, # Integer | The number of items to skip when paging through large result sets.
+  awaits_activation: true # Boolean | If `true`: Filters results to include only point transactions that have action-based activation and have not expired.  If `false`: Returns a `400` response. 
+}
+
+begin
+  # List customer's loyalty transactions
+  result = api_instance.get_loyalty_program_profile_ledger_transactions(loyalty_program_id, integration_id, opts)
+  p result
+rescue TalonOne::ApiError => e
+  puts "Error when calling ManagementApi->get_loyalty_program_profile_ledger_transactions: #{e}"
+end
+```
+
+#### Using the get_loyalty_program_profile_ledger_transactions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetLoyaltyProgramProfileTransactions200Response>, Integer, Hash)> get_loyalty_program_profile_ledger_transactions_with_http_info(loyalty_program_id, integration_id, opts)
+
+```ruby
+begin
+  # List customer's loyalty transactions
+  data, status_code, headers = api_instance.get_loyalty_program_profile_ledger_transactions_with_http_info(loyalty_program_id, integration_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetLoyaltyProgramProfileTransactions200Response>
+rescue TalonOne::ApiError => e
+  puts "Error when calling ManagementApi->get_loyalty_program_profile_ledger_transactions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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.  |  |
+| **integration_id** | **String** | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID.  Once set, you cannot update this identifier.  |  |
+| **customer_session_ids** | [**Array&lt;String&gt;**](String.md) | Filter the results by a list of customer session IDs.   To include multiple IDs, repeat the parameter for each one, for example,  &#x60;?customerSessionIDs&#x3D;id1&amp;customerSessionIDs&#x3D;id2&#x60;.  The response contains only data associated with the specified sessions.  | [optional] |
+| **transaction_uuids** | [**Array&lt;String&gt;**](String.md) | Filter the results by a list of transaction UUIDs.  To include multiple IDs, repeat the parameter for each one, for example,  &#x60;?transactionUUIDs&#x3D;uuid1&amp;transactionUUIDs&#x3D;uuid2&#x60;.  The response contains only data associated with the specified transactions.  | [optional] |
+| **subledger_id** | **String** | The ID of the subledger used to filter the data. Leave this value empty (\&quot;\&quot;) to query the main ledger. | [optional] |
+| **loyalty_transaction_type** | **String** | Filter results by loyalty transaction type: - &#x60;manual&#x60;: Loyalty transaction that was done manually. - &#x60;session&#x60;: Loyalty transaction that resulted from a customer session. - &#x60;import&#x60;: Loyalty transaction that was imported from a CSV file.  | [optional] |
+| **start_date** | **Time** | Date and time from which results are returned. Results are filtered by transaction creation date.  **Note:**  - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.  | [optional] |
+| **end_date** | **Time** | Date and time by which results are returned. Results are filtered by transaction creation date.  **Note:**  - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.  | [optional] |
+| **page_size** | **Integer** | The number of items in the response. | [optional][default to 50] |
+| **skip** | **Integer** | The number of items to skip when paging through large result sets. | [optional] |
+| **awaits_activation** | **Boolean** | If &#x60;true&#x60;: Filters results to include only point transactions that have action-based activation and have not expired.  If &#x60;false&#x60;: Returns a &#x60;400&#x60; response.  | [optional] |
+
+### Return type
+
+[**GetLoyaltyProgramProfileTransactions200Response**](GetLoyaltyProgramProfileTransactions200Response.md)
+
+### Authorization
+
+[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth), [api_key_v1](../README.md#api_key_v1)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_loyalty_program_transactions
 
 > <GetLoyaltyProgramTransactions200Response> get_loyalty_program_transactions(loyalty_program_id, opts)
@@ -9333,7 +9621,8 @@ opts = {
   start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Date and time from which results are returned. Results are filtered by transaction creation date.  **Note:**  - It 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. 
   end_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Date and time by which results are returned. Results are filtered by transaction creation date.  **Note:**  - It 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. 
   page_size: 789, # Integer | The number of items in the response.
-  skip: 789 # Integer | The number of items to skip when paging through large result sets.
+  skip: 789, # Integer | The number of items to skip when paging through large result sets.
+  awaits_activation: true # Boolean | If `true`: Filters results to include only point transactions that have action-based activation and have not expired.  If `false`: Returns a `400` response. 
 }
 
 begin
@@ -9376,6 +9665,7 @@ end
 | **end_date** | **Time** | Date and time by which results are returned. Results are filtered by transaction creation date.  **Note:**  - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, &#x60;T23:59:59&#x60; to specify the end of the day. The time zone setting considered is &#x60;UTC&#x60;. If you do not include a time component, a default time value of &#x60;T00:00:00&#x60; (midnight) in &#x60;UTC&#x60; is considered.  | [optional] |
 | **page_size** | **Integer** | The number of items in the response. | [optional][default to 50] |
 | **skip** | **Integer** | The number of items to skip when paging through large result sets. | [optional] |
+| **awaits_activation** | **Boolean** | If &#x60;true&#x60;: Filters results to include only point transactions that have action-based activation and have not expired.  If &#x60;false&#x60;: Returns a &#x60;400&#x60; response.  | [optional] |
 
 ### Return type
 

data/docs/NewCollectionsCatalog.md

@@ -0,0 +1,26 @@
+# TalonOne::NewCollectionsCatalog
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | The display name for the collection catalog. |  |
+| **description** | **String** | A longer, more detailed description of the collection catalog. | [optional] |
+| **category** | **String** | Category used to group collection catalogs. | [optional][default to 'custom'] |
+| **rules** | [**Array<CatalogRule>**](CatalogRule.md) | Array of rules to store in this collection catalog. Rules should only contain title (no description, as description is at the collection catalog level). At least one rule or cart item filter is required. | [optional] |
+| **cart_item_filters** | [**Array<CartItemFilterTemplate>**](CartItemFilterTemplate.md) | Array of cart item filters to store in this collection catalog. If not provided, will be extracted from the rules. Cart item filters should only contain name (no description, as description is at the collection catalog level). | [optional] |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::NewCollectionsCatalog.new(
+  title: Customer loyalty boost,
+  description: null,
+  category: null,
+  rules: null,
+  cart_item_filters: null
+)
+```
+

data/docs/NewRole.md

@@ -17,7 +17,7 @@ require 'talon_one_sdk'
 instance = TalonOne::NewRole.new(
   name: Campaign Manager,
   description: Manages the campaigns,
-  acl: {Role=128, Applications=null},
+  acl: {Role=128},
   members: [48, 562, 475, 18]
 )
 ```

data/docs/PrismaticEventPayloadCouponBasedNotifications.md

@@ -22,6 +22,8 @@
 | **batch_id** | **String** |  | [optional] |
 | **attributes** | **Object** |  | [optional] |
 | **limits** | [**Array<PrismaticEventPayloadCouponBasedNotificationsLimits>**](PrismaticEventPayloadCouponBasedNotificationsLimits.md) |  | [optional] |
+| **source_of_event** | **String** |  |  |
+| **employee_name** | **String** |  |  |
 
 ## Example
 
@@ -46,7 +48,9 @@ instance = TalonOne::PrismaticEventPayloadCouponBasedNotifications.new(
   import_id: null,
   batch_id: null,
   attributes: null,
-  limits: null
+  limits: null,
+  source_of_event: null,
+  employee_name: null
 )
 ```
 

data/docs/UpdateCollectionsCatalog.md

@@ -0,0 +1,26 @@
+# TalonOne::UpdateCollectionsCatalog
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | The display name for the collection catalog. | [optional] |
+| **description** | **String** | A longer, more detailed description of the collection catalog. | [optional] |
+| **category** | **String** | Category used to group collection catalogs. | [optional] |
+| **rules** | [**Array<CatalogRule>**](CatalogRule.md) | Replaces the stored rules. Rules should only contain title (no description, as description is at the collection catalog level). | [optional] |
+| **cart_item_filters** | [**Array<CartItemFilterTemplate>**](CartItemFilterTemplate.md) | Replaces the stored cart item filters. Cart item filters should only contain name (no description, as description is at the collection catalog level). | [optional] |
+
+## Example
+
+```ruby
+require 'talon_one_sdk'
+
+instance = TalonOne::UpdateCollectionsCatalog.new(
+  title: null,
+  description: null,
+  category: null,
+  rules: null,
+  cart_item_filters: null
+)
+```
+

data/docs/UpdateRole.md

@@ -17,7 +17,7 @@ require 'talon_one_sdk'
 instance = TalonOne::UpdateRole.new(
   name: Campaign Manager,
   description: Manages the campaigns,
-  acl: {Role=128, Applications=null},
+  acl: {Role=128},
   members: [48, 562, 475, 18]
 )
 ```

data/docs/UpdateUser.md

@@ -20,7 +20,7 @@ instance = TalonOne::UpdateUser.new(
   name: John Doe,
   state: deactivated,
   is_admin: false,
-  policy: {Role=127, Applications=null},
+  policy: {Role=127},
   roles: [1, 3],
   application_notification_subscriptions: null
 )

data/docs/User.md

@@ -37,7 +37,7 @@ instance = TalonOne::User.new(
   state: invited,
   invite_token: Gy9b8w1irmQtEPo5RmbMmSPheL5h4,
   is_admin: false,
-  policy: {Role=127, Applications=null},
+  policy: {Role=127},
   roles: [71],
   auth_method: basic_auth,
   application_notification_subscriptions: {},

data/docs/WebhookAuthentication.md

@@ -4,15 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | The name of the webhook authentication. |  |
-| **type** | **String** |  |  |
-| **data** | **Object** |  |  |
 | **id** | **Integer** | The internal ID of this entity. |  |
 | **created** | **Time** | The time this entity was created. |  |
 | **modified** | **Time** | The time this entity was last modified. |  |
 | **created_by** | **String** | The name of the user who created the webhook authentication. |  |
 | **modified_by** | **String** | The name of the user who last modified the webhook authentication. |  |
 | **webhooks** | [**Array<WebhookAuthenticationWebhookRef>**](WebhookAuthenticationWebhookRef.md) |  |  |
+| **name** | **String** | The name of the webhook authentication. |  |
+| **type** | **String** |  |  |
+| **data** | **Object** |  |  |
 
 ## Example
 
@@ -20,15 +20,15 @@
 require 'talon_one_sdk'
 
 instance = TalonOne::WebhookAuthentication.new(
-  name: My basic auth,
-  type: null,
-  data: null,
   id: 6,
   created: 2020-06-10T09:05:27.993483Z,
   modified: 2021-09-12T10:12:42Z,
   created_by: null,
   modified_by: null,
-  webhooks: null
+  webhooks: null,
+  name: My basic auth,
+  type: null,
+  data: null
 )
 ```