ultracart_api 4.1.10 → 4.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b01ac862096e8fd63e87cc60bc013c7b30d97c365616ccc9efde2ed9aeb94af3
-  data.tar.gz: 25b1395b09358ccf57ebeb6787e36f0d63690591f90a22ef53f5fbd7e89afe23
+  metadata.gz: 69102a25b45643b1a65dc8ffb1acf59215dea3a1fab2a585bfd0f20da1095f30
+  data.tar.gz: df0465e38a715afc022c7b1371f891b4369c7ee22056f3dce43b13d26589461f
 SHA512:
-  metadata.gz: aa5bf1ac30d606b75f2a268899d362f72974848524e82fc87a0f72b9b399bf37ae089c86569687daf6682d8b874598b86be8fe93eec25dfc9d34fd5759543b10
-  data.tar.gz: 1ecc02e30a1a4c1e006b2d73d6d20843cd07547ee80334489b5a5cee4ed42a723a96a47167d458e661d40fff313d1f239a13f3e3c68c35ab5adecd25ae9fc17b
+  metadata.gz: 9749a34ba80d6414a07d8235218886f14c5f0dac7f6786828d1e32d0d50c1c364b82090944d325c0733b2dd2664d0e83c314ddaebc5093c43be3421dd8442a0c
+  data.tar.gz: eed807659d9c845e5127417b87903b75c12ee0f31dad82bfc64de649877e87b9633cb5cd19558dc6f1efa13ab40253a0af70acf4e0fb382ab9d2e659bd15ba6c

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.10
+- Package version: 4.1.12
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.10'
+gem 'ultracart_api', '4.1.12'
 ```
 
 install:
@@ -187,6 +187,8 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_pbx_time_ranges**](docs/ConversationApi.md#get_pbx_time_ranges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges
 *UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailbox**](docs/ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox
 *UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailboxes**](docs/ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
+*UltracartClient::ConversationApi* | [**get_virtual_agent_budget**](docs/ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
+*UltracartClient::ConversationApi* | [**get_virtual_agent_capabilities**](docs/ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
 *UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
 *UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
 *UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
@@ -218,6 +220,8 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**update_pbx_time_based**](docs/ConversationApi.md#update_pbx_time_based) | **PUT** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Update pbx timeBased
 *UltracartClient::ConversationApi* | [**update_pbx_time_range**](docs/ConversationApi.md#update_pbx_time_range) | **PUT** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Update pbx timeRange
 *UltracartClient::ConversationApi* | [**update_pbx_voicemail_mailbox**](docs/ConversationApi.md#update_pbx_voicemail_mailbox) | **PUT** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Update pbx voicemailMailbox
+*UltracartClient::ConversationApi* | [**update_virtual_agent_budget**](docs/ConversationApi.md#update_virtual_agent_budget) | **PUT** /conversation/virtualagent/budget | Update virtual agent budget
+*UltracartClient::ConversationApi* | [**update_virtual_agent_capabilities**](docs/ConversationApi.md#update_virtual_agent_capabilities) | **PUT** /conversation/virtualagent/capabilities | Update virtual agent capabilities
 *UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
 *UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
 *UltracartClient::CouponApi* | [**delete_coupons_by_oid**](docs/CouponApi.md#delete_coupons_by_oid) | **DELETE** /coupon/coupons/by_oid | Deletes multiple coupons
@@ -808,6 +812,10 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
  - [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
  - [UltracartClient::ConversationTwilioAccount](docs/ConversationTwilioAccount.md)
+ - [UltracartClient::ConversationVirtualAgentBudget](docs/ConversationVirtualAgentBudget.md)
+ - [UltracartClient::ConversationVirtualAgentBudgetResponse](docs/ConversationVirtualAgentBudgetResponse.md)
+ - [UltracartClient::ConversationVirtualAgentCapabilities](docs/ConversationVirtualAgentCapabilities.md)
+ - [UltracartClient::ConversationVirtualAgentCapabilitiesResponse](docs/ConversationVirtualAgentCapabilitiesResponse.md)
  - [UltracartClient::ConversationWebchatContext](docs/ConversationWebchatContext.md)
  - [UltracartClient::ConversationWebchatQueueStatus](docs/ConversationWebchatQueueStatus.md)
  - [UltracartClient::ConversationWebchatQueueStatusAgent](docs/ConversationWebchatQueueStatusAgent.md)
@@ -1522,6 +1530,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.12 | 05/19/2025 | conversations - AI agent capabilities method |
+| 4.1.11 | 05/19/2025 | conversations - virtual AI budgets |
 | 4.1.10 | 05/06/2025 | conversation - ConversationAgentProfile.user_id added for agent profiles call |
 | 4.1.9 | 05/05/2025 | conversations - method to fetch all agent profiles for admin screens |
 | 4.1.8 | 04/22/2025 | order property fields for created_by and created_dts |

data/docs/ConversationApi.md

@@ -57,6 +57,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_pbx_time_ranges**](ConversationApi.md#get_pbx_time_ranges) | **GET** /conversation/pbx/time_range | Get pbx timeRanges |
 | [**get_pbx_voicemail_mailbox**](ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox |
 | [**get_pbx_voicemail_mailboxes**](ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes |
+| [**get_virtual_agent_budget**](ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget |
+| [**get_virtual_agent_capabilities**](ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities |
 | [**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message |
 | [**insert_conversation_department**](ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department |
 | [**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement |
@@ -88,6 +90,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**update_pbx_time_based**](ConversationApi.md#update_pbx_time_based) | **PUT** /conversation/pbx/time_based/{conversationPbxTimeBasedUuid} | Update pbx timeBased |
 | [**update_pbx_time_range**](ConversationApi.md#update_pbx_time_range) | **PUT** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Update pbx timeRange |
 | [**update_pbx_voicemail_mailbox**](ConversationApi.md#update_pbx_voicemail_mailbox) | **PUT** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Update pbx voicemailMailbox |
+| [**update_virtual_agent_budget**](ConversationApi.md#update_virtual_agent_budget) | **PUT** /conversation/virtualagent/budget | Update virtual agent budget |
+| [**update_virtual_agent_capabilities**](ConversationApi.md#update_virtual_agent_capabilities) | **PUT** /conversation/virtualagent/capabilities | Update virtual agent capabilities |
 
 
 ## delete_conversation_canned_message
@@ -3809,6 +3813,142 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## get_virtual_agent_budget
+
+> <ConversationVirtualAgentBudgetResponse> get_virtual_agent_budget
+
+Get virtual agent budget
+
+Retrieve virtual agent budget 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+begin
+  # Get virtual agent budget
+  result = api_instance.get_virtual_agent_budget
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_virtual_agent_budget: #{e}"
+end
+```
+
+#### Using the get_virtual_agent_budget_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationVirtualAgentBudgetResponse>, Integer, Hash)> get_virtual_agent_budget_with_http_info
+
+```ruby
+begin
+  # Get virtual agent budget
+  data, status_code, headers = api_instance.get_virtual_agent_budget_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationVirtualAgentBudgetResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_virtual_agent_budget_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConversationVirtualAgentBudgetResponse**](ConversationVirtualAgentBudgetResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_virtual_agent_capabilities
+
+> <ConversationVirtualAgentCapabilitiesResponse> get_virtual_agent_capabilities
+
+Get virtual agent capabilities
+
+Retrieve virtual agent capabilities 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+begin
+  # Get virtual agent capabilities
+  result = api_instance.get_virtual_agent_capabilities
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_virtual_agent_capabilities: #{e}"
+end
+```
+
+#### Using the get_virtual_agent_capabilities_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationVirtualAgentCapabilitiesResponse>, Integer, Hash)> get_virtual_agent_capabilities_with_http_info
+
+```ruby
+begin
+  # Get virtual agent capabilities
+  data, status_code, headers = api_instance.get_virtual_agent_capabilities_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationVirtualAgentCapabilitiesResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_virtual_agent_capabilities_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConversationVirtualAgentCapabilitiesResponse**](ConversationVirtualAgentCapabilitiesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## insert_conversation_canned_message
 
 > <ConversationCannedMessageResponse> insert_conversation_canned_message(canned_message)
@@ -6031,3 +6171,145 @@ end
 - **Content-Type**: application/json
 - **Accept**: application/json
 
+
+## update_virtual_agent_budget
+
+> <ConversationVirtualAgentBudgetResponse> update_virtual_agent_budget(virtual_agent_budget)
+
+Update virtual agent budget
+
+Update virtual agent budget 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+virtual_agent_budget = UltracartClient::ConversationVirtualAgentBudget.new # ConversationVirtualAgentBudget | Virtual Agent Budget
+
+begin
+  # Update virtual agent budget
+  result = api_instance.update_virtual_agent_budget(virtual_agent_budget)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->update_virtual_agent_budget: #{e}"
+end
+```
+
+#### Using the update_virtual_agent_budget_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationVirtualAgentBudgetResponse>, Integer, Hash)> update_virtual_agent_budget_with_http_info(virtual_agent_budget)
+
+```ruby
+begin
+  # Update virtual agent budget
+  data, status_code, headers = api_instance.update_virtual_agent_budget_with_http_info(virtual_agent_budget)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationVirtualAgentBudgetResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->update_virtual_agent_budget_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **virtual_agent_budget** | [**ConversationVirtualAgentBudget**](ConversationVirtualAgentBudget.md) | Virtual Agent Budget |  |
+
+### Return type
+
+[**ConversationVirtualAgentBudgetResponse**](ConversationVirtualAgentBudgetResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_virtual_agent_capabilities
+
+> <ConversationVirtualAgentCapabilitiesResponse> update_virtual_agent_capabilities(virtual_agent_capabilities)
+
+Update virtual agent capabilities
+
+Update virtual agent capabilities 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+virtual_agent_capabilities = UltracartClient::ConversationVirtualAgentCapabilities.new # ConversationVirtualAgentCapabilities | Virtual Agent Capabilities
+
+begin
+  # Update virtual agent capabilities
+  result = api_instance.update_virtual_agent_capabilities(virtual_agent_capabilities)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->update_virtual_agent_capabilities: #{e}"
+end
+```
+
+#### Using the update_virtual_agent_capabilities_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationVirtualAgentCapabilitiesResponse>, Integer, Hash)> update_virtual_agent_capabilities_with_http_info(virtual_agent_capabilities)
+
+```ruby
+begin
+  # Update virtual agent capabilities
+  data, status_code, headers = api_instance.update_virtual_agent_capabilities_with_http_info(virtual_agent_capabilities)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationVirtualAgentCapabilitiesResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->update_virtual_agent_capabilities_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **virtual_agent_capabilities** | [**ConversationVirtualAgentCapabilities**](ConversationVirtualAgentCapabilities.md) | Virtual Agent Capabilities |  |
+
+### Return type
+
+[**ConversationVirtualAgentCapabilitiesResponse**](ConversationVirtualAgentCapabilitiesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ConversationVirtualAgentBudget.md

@@ -0,0 +1,24 @@
+# UltracartClient::ConversationVirtualAgentBudget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget_daily** | **Float** |  | [optional] |
+| **budget_monthly** | **Float** |  | [optional] |
+| **used_daily** | **Float** |  | [optional] |
+| **used_monthly** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationVirtualAgentBudget.new(
+  budget_daily: null,
+  budget_monthly: null,
+  used_daily: null,
+  used_monthly: null
+)
+```
+

data/docs/ConversationVirtualAgentBudgetResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationVirtualAgentBudgetResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **budget** | [**ConversationVirtualAgentBudget**](ConversationVirtualAgentBudget.md) |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationVirtualAgentBudgetResponse.new(
+  budget: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationVirtualAgentCapabilities.md

@@ -0,0 +1,34 @@
+# UltracartClient::ConversationVirtualAgentCapabilities
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cancel_subscription** | **Boolean** |  | [optional] |
+| **delay_subscription** | **Boolean** |  | [optional] |
+| **lookup_order_information** | **Boolean** |  | [optional] |
+| **lookup_subscription_information** | **Boolean** |  | [optional] |
+| **open_support_ticket** | **Boolean** |  | [optional] |
+| **pause_subscription** | **Boolean** |  | [optional] |
+| **resume_subscription** | **Boolean** |  | [optional] |
+| **transfer_chat_to_live_agent** | **Boolean** |  | [optional] |
+| **update_subscription_credit_card** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationVirtualAgentCapabilities.new(
+  cancel_subscription: null,
+  delay_subscription: null,
+  lookup_order_information: null,
+  lookup_subscription_information: null,
+  open_support_ticket: null,
+  pause_subscription: null,
+  resume_subscription: null,
+  transfer_chat_to_live_agent: null,
+  update_subscription_credit_card: null
+)
+```
+

data/docs/ConversationVirtualAgentCapabilitiesResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationVirtualAgentCapabilitiesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **capabilities** | [**ConversationVirtualAgentCapabilities**](ConversationVirtualAgentCapabilities.md) |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationVirtualAgentCapabilitiesResponse.new(
+  capabilities: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+