ultracart_api 4.0.94.rc → 4.0.95.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 345dfbd650f7482716965b7a524e0a541905c7452d61b6fcf6b25217ba8722fc
-  data.tar.gz: f8fcc2cfc62e8335ae3ed187737999d4054a3601435cb27619cb7c1a02908802
+  metadata.gz: 36e518c83bd978f50011032dbcb6aced171395215db766263e3f18715e875682
+  data.tar.gz: bd6c2d10572e34a4faf79ae5f9672f7fa4830938419249983eff85414fc4a1f8
 SHA512:
-  metadata.gz: 9b42a58503acef5e404e1acdb37c458f25b9160eda970c257a0f8d9c152114211b7b77dfd3a8426b9854750536108ef110df04ef0d259cd6072fc3b2f37d5a24
-  data.tar.gz: e151789a9cf8d44a2abb0be910a989c87ce9a185d2787995199f80a5f0451a18218b03484fbbf95fbb6cb7062490b387103f6c9920626f6f091b2ac7aa2898c0
+  metadata.gz: 99b661a9ad10ff5f1e14d18bd214e63928655712f9ac0be1cb186352655055d4660a57d07fb1ff217d3ffda7a82cd67de11d353865d3ff52ff4d92eadc8bb22c
+  data.tar.gz: dd631f76a7580b5aa371454453908f383eb3fa85c4465d7b133d3d6849e7a029ec9b2f71b359626095682c5f16184aa29261ace258919ba79952514924bc021d

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.94.rc
+- Package version: 4.0.95.rc
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.94.rc.gem
+gem install ./ultracart_api-4.0.95.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.94.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.95.rc.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 4.0.94.rc'
+    gem 'ultracart_api', '~> 4.0.95.rc'
 
 ### Install from Git
 
@@ -134,15 +134,19 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
 *UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
 *UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
+*UltracartClient::ConversationApi* | [**get_conversation_canned_messages**](docs/ConversationApi.md#get_conversation_canned_messages) | **GET** /conversation/canned_messages | Retrieve a list of canned messages ordered by short_code
 *UltracartClient::ConversationApi* | [**get_conversation_context**](docs/ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
 *UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
 *UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
 *UltracartClient::ConversationApi* | [**get_conversation_webchat_queue_statuses**](docs/ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
 *UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
+*UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
 *UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
 *UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
 *UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
+*UltracartClient::ConversationApi* | [**search_conversation_canned_messages**](docs/ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
 *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
+*UltracartClient::ConversationApi* | [**update_conversation_canned_message**](docs/ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
 *UltracartClient::ConversationApi* | [**update_conversation_webchat_queue_status**](docs/ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
 *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
@@ -591,6 +595,10 @@ Class | Method | HTTP request | Description
  - [UltracartClient::Conversation](docs/Conversation.md)
  - [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
  - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
+ - [UltracartClient::ConversationCannedMessage](docs/ConversationCannedMessage.md)
+ - [UltracartClient::ConversationCannedMessageResponse](docs/ConversationCannedMessageResponse.md)
+ - [UltracartClient::ConversationCannedMessagesResponse](docs/ConversationCannedMessagesResponse.md)
+ - [UltracartClient::ConversationCannedMessagesSearch](docs/ConversationCannedMessagesSearch.md)
  - [UltracartClient::ConversationEventAddCoupon](docs/ConversationEventAddCoupon.md)
  - [UltracartClient::ConversationEventAddItem](docs/ConversationEventAddItem.md)
  - [UltracartClient::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
@@ -1236,6 +1244,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.95-RC | 12/08/2022 | conversation canned messages |
 | 4.0.94-RC | 12/08/2022 | communications - expose the rebuild percentage |
 | 4.0.93-RC | 12/06/2022 | convo - add session_start_dts to webchat context, cart - add customer_profile.signup_dts |
 | 4.0.92-RC | 12/06/2022 | customer api - expose edi information and editor values |

data/docs/ConversationApi.md

@@ -7,15 +7,19 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive |
 | [**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization |
 | [**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation |
+| [**get_conversation_canned_messages**](ConversationApi.md#get_conversation_canned_messages) | **GET** /conversation/canned_messages | Retrieve a list of canned messages ordered by short_code |
 | [**get_conversation_context**](ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context |
 | [**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages |
 | [**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL |
 | [**get_conversation_webchat_queue_statuses**](ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses |
 | [**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest |
+| [**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message |
 | [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation |
 | [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation |
 | [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read |
+| [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code |
 | [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation |
+| [**update_conversation_canned_message**](ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message |
 | [**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue |
 
 
@@ -229,6 +233,74 @@ end
 - **Accept**: application/json
 
 
+## get_conversation_canned_messages
+
+> <ConversationCannedMessagesResponse> get_conversation_canned_messages
+
+Retrieve a list of canned messages ordered by short_code
+
+Retrieve a list of canned messages ordered by short_code 
+
+### 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
+  # Retrieve a list of canned messages ordered by short_code
+  result = api_instance.get_conversation_canned_messages
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversation_canned_messages: #{e}"
+end
+```
+
+#### Using the get_conversation_canned_messages_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationCannedMessagesResponse>, Integer, Hash)> get_conversation_canned_messages_with_http_info
+
+```ruby
+begin
+  # Retrieve a list of canned messages ordered by short_code
+  data, status_code, headers = api_instance.get_conversation_canned_messages_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationCannedMessagesResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversation_canned_messages_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_conversation_context
 
 > <ConversationWebchatContext> get_conversation_context(conversation_uuid)
@@ -595,6 +667,77 @@ end
 - **Accept**: application/json
 
 
+## insert_conversation_canned_message
+
+> <ConversationCannedMessageResponse> insert_conversation_canned_message(canned_message)
+
+Insert a canned message
+
+Insert a canned message 
+
+### 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)
+canned_message = UltracartClient::ConversationCannedMessage.new # ConversationCannedMessage | Canned message
+
+begin
+  # Insert a canned message
+  result = api_instance.insert_conversation_canned_message(canned_message)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->insert_conversation_canned_message: #{e}"
+end
+```
+
+#### Using the insert_conversation_canned_message_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationCannedMessageResponse>, Integer, Hash)> insert_conversation_canned_message_with_http_info(canned_message)
+
+```ruby
+begin
+  # Insert a canned message
+  data, status_code, headers = api_instance.insert_conversation_canned_message_with_http_info(canned_message)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationCannedMessageResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->insert_conversation_canned_message_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md) | Canned message |  |
+
+### Return type
+
+[**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## join_conversation
 
 > join_conversation(conversation_uuid)
@@ -805,6 +948,77 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## search_conversation_canned_messages
+
+> <ConversationCannedMessagesResponse> search_conversation_canned_messages(search_request)
+
+Search for canned messages by short_code
+
+Search for canned messages by short_code 
+
+### 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)
+search_request = UltracartClient::ConversationCannedMessagesSearch.new # ConversationCannedMessagesSearch | Search request
+
+begin
+  # Search for canned messages by short_code
+  result = api_instance.search_conversation_canned_messages(search_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->search_conversation_canned_messages: #{e}"
+end
+```
+
+#### Using the search_conversation_canned_messages_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationCannedMessagesResponse>, Integer, Hash)> search_conversation_canned_messages_with_http_info(search_request)
+
+```ruby
+begin
+  # Search for canned messages by short_code
+  data, status_code, headers = api_instance.search_conversation_canned_messages_with_http_info(search_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationCannedMessagesResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->search_conversation_canned_messages_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **search_request** | [**ConversationCannedMessagesSearch**](ConversationCannedMessagesSearch.md) | Search request |  |
+
+### Return type
+
+[**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## start_conversation
 
 > <ConversationStartResponse> start_conversation(start_request)
@@ -876,6 +1090,79 @@ end
 - **Accept**: application/json
 
 
+## update_conversation_canned_message
+
+> <ConversationCannedMessageResponse> update_conversation_canned_message(conversation_canned_message_oid, canned_message)
+
+Update a canned message
+
+Update a canned message 
+
+### 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)
+conversation_canned_message_oid = 56 # Integer | 
+canned_message = UltracartClient::ConversationCannedMessage.new # ConversationCannedMessage | Canned message
+
+begin
+  # Update a canned message
+  result = api_instance.update_conversation_canned_message(conversation_canned_message_oid, canned_message)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->update_conversation_canned_message: #{e}"
+end
+```
+
+#### Using the update_conversation_canned_message_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationCannedMessageResponse>, Integer, Hash)> update_conversation_canned_message_with_http_info(conversation_canned_message_oid, canned_message)
+
+```ruby
+begin
+  # Update a canned message
+  data, status_code, headers = api_instance.update_conversation_canned_message_with_http_info(conversation_canned_message_oid, canned_message)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationCannedMessageResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->update_conversation_canned_message_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_canned_message_oid** | **Integer** |  |  |
+| **canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md) | Canned message |  |
+
+### Return type
+
+[**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## update_conversation_webchat_queue_status
 
 > update_conversation_webchat_queue_status(queue_name, status_request)

data/docs/ConversationCannedMessage.md

@@ -0,0 +1,24 @@
+# UltracartClient::ConversationCannedMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **canned_message** | **String** |  | [optional] |
+| **conversation_canned_message_oid** | **Integer** |  | [optional] |
+| **conversation_webchat_queue_uuids** | **Array<String>** |  | [optional] |
+| **short_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationCannedMessage.new(
+  canned_message: null,
+  conversation_canned_message_oid: null,
+  conversation_webchat_queue_uuids: null,
+  short_code: null
+)
+```
+

data/docs/ConversationCannedMessageResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationCannedMessageResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.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::ConversationCannedMessageResponse.new(
+  conversation_canned_message: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationCannedMessagesResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationCannedMessagesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_canned_messages** | [**Array<ConversationCannedMessage>**](ConversationCannedMessage.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::ConversationCannedMessagesResponse.new(
+  conversation_canned_messages: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationCannedMessagesSearch.md

@@ -0,0 +1,20 @@
+# UltracartClient::ConversationCannedMessagesSearch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **max_results** | **Integer** |  | [optional] |
+| **short_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationCannedMessagesSearch.new(
+  max_results: null,
+  short_code: null
+)
+```
+