ultracart_api 4.0.34.rc → 4.0.37.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbe44d03ad11dc64657aa8f18822639cebf0c01d6db7f964a139878a58ebf2cf
-  data.tar.gz: c905a454f5b9e395920e921c9c2bcc5b268609e0201dad657d8ca583bc64e42f
+  metadata.gz: e48b47e3d743b9314c562b3ea981b605cee052fc7c3b62fa4f7da74fdf4b5f47
+  data.tar.gz: 924dcfa7461c242d2a003693373f4392b9e5ab7c30b70991579d19ff7b87f3f0
 SHA512:
-  metadata.gz: 3f0087f2ec57a2c12e808c923dde41d84f8573fb27a538aa6f458ccc68d1dac3eda48b330cd1c5dfe84f9dc02f71f612d724b52ec93e92d2db5d1871fd1f9284
-  data.tar.gz: 0c81fd7bea7afcbaf3fa4a1de2b811cc127f59064bc5115bd984d183506cf1582ddbb26465cb2ff6f8c4786b183e560aa5b5c656e513c0a31948daa4732ad3fc
+  metadata.gz: 9d99937360395a25c786acd38a43836b12ee8b1fb1b98f21baee01105883b62ee9e045e6d8da6c77acefa6055afb4db52b89f985e523aeb6943c957de4bcbfb2
+  data.tar.gz: 4f945414957aed966fe9fb356befaf49b9ee2691139834afb5990edc3ed43e5c9389eedd09997ba05ce48beffad263185f6c9d9e0f870cdc6b991fd78bc3987c

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.34.rc
+- Package version: 4.0.37.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.34.rc.gem
+gem install ./ultracart_api-4.0.37.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.34.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.37.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.34.rc'
+    gem 'ultracart_api', '~> 4.0.37.rc'
 
 ### Install from Git
 
@@ -131,6 +131,13 @@ Class | Method | HTTP request | Description
 *UltracartClient::CheckoutApi* | [**setup_browser_key**](docs/CheckoutApi.md#setup_browser_key) | **PUT** /checkout/browser_key | Setup Browser Application
 *UltracartClient::CheckoutApi* | [**update_cart**](docs/CheckoutApi.md#update_cart) | **PUT** /checkout/cart | Update cart
 *UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
+*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_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_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
+*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* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
 *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
@@ -554,6 +561,15 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CheckoutSetupBrowserKeyResponse](docs/CheckoutSetupBrowserKeyResponse.md)
  - [UltracartClient::CheckoutStateProvinceResponse](docs/CheckoutStateProvinceResponse.md)
  - [UltracartClient::CityStateZip](docs/CityStateZip.md)
+ - [UltracartClient::Conversation](docs/Conversation.md)
+ - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
+ - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
+ - [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
+ - [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
+ - [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
+ - [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
+ - [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
+ - [UltracartClient::ConversationsResponse](docs/ConversationsResponse.md)
  - [UltracartClient::CountriesResponse](docs/CountriesResponse.md)
  - [UltracartClient::Country](docs/Country.md)
  - [UltracartClient::Coupon](docs/Coupon.md)
@@ -1102,6 +1118,8 @@ Class | Method | HTTP request | Description
   - checkout_write: Allows you to write checkout information.
   - configuration_read: Allows you to read configuration information.
   - configuration_write: Allows you to write configuration information.
+  - conversation_read: Allows you to read conversation information.
+  - conversation_write: Allows you to write conversation information.
   - coupon_read: Allows you to read coupon information.
   - coupon_write: Allows you to write coupon information.
   - customer_read: Allows you to read customer information.
@@ -1142,6 +1160,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.37-RC | 07/20/2022 | conversation participant name added |
+| 4.0.36-RC | 07/18/2022 | twilio dev |
+| 4.0.35-RC | 07/14/2022 | Add channel storefront_oid to the customer activity record |
 | 4.0.34-RC | 07/11/2022 | Customer API - mergeCustomer method |
 | 4.0.33-RC | 07/05/2022 | docs update |
 | 4.0.32-RC | 06/24/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |

data/docs/Activity.md

@@ -5,7 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **action** | **String** |  | [optional] |
+| **channel** | **String** |  | [optional] |
 | **metric** | **String** |  | [optional] |
+| **storefront_oid** | **Integer** |  | [optional] |
 | **subject** | **String** |  | [optional] |
 | **ts** | **Integer** |  | [optional] |
 | **type** | **String** |  | [optional] |
@@ -18,7 +20,9 @@ require 'ultracart_api'
 
 instance = UltracartClient::Activity.new(
   action: null,
+  channel: null,
   metric: null,
+  storefront_oid: null,
   subject: null,
   ts: null,
   type: null,

data/docs/Conversation.md

@@ -0,0 +1,26 @@
+# UltracartClient::Conversation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_arn** | **String** |  | [optional] |
+| **conversation_uuid** | **String** |  | [optional] |
+| **merchant_id** | **String** |  | [optional] |
+| **messages** | [**Array<ConversationMessage>**](ConversationMessage.md) |  | [optional] |
+| **participants** | [**Array<ConversationParticipant>**](ConversationParticipant.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::Conversation.new(
+  conversation_arn: null,
+  conversation_uuid: null,
+  merchant_id: null,
+  messages: null,
+  participants: null
+)
+```
+

data/docs/ConversationAgentAuthResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::ConversationAgentAuthResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_participant_arn** | **String** |  | [optional] |
+| **conversation_participant_name** | **String** |  | [optional] |
+| **jwt** | **String** |  | [optional] |
+| **merchant_id** | **String** |  | [optional] |
+| **twilio_phone_numbers** | **Array<String>** |  | [optional] |
+| **websocket_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentAuthResponse.new(
+  conversation_participant_arn: null,
+  conversation_participant_name: null,
+  jwt: null,
+  merchant_id: null,
+  twilio_phone_numbers: null,
+  websocket_url: null
+)
+```
+

data/docs/ConversationApi.md

@@ -0,0 +1,509 @@
+# UltracartClient::ConversationApi
+
+All URIs are relative to *https://secure.ultracart.com/rest/v2*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**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_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL |
+| [**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest |
+| [**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 |
+| [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation |
+
+
+## get_agent_websocket_authorization
+
+> <ConversationAgentAuthResponse> get_agent_websocket_authorization
+
+Get agent websocket authorization
+
+Retrieve a JWT to authorize an agent to make a websocket connection. 
+
+### 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 agent websocket authorization
+  result = api_instance.get_agent_websocket_authorization
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_agent_websocket_authorization: #{e}"
+end
+```
+
+#### Using the get_agent_websocket_authorization_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationAgentAuthResponse>, Integer, Hash)> get_agent_websocket_authorization_with_http_info
+
+```ruby
+begin
+  # Get agent websocket authorization
+  data, status_code, headers = api_instance.get_agent_websocket_authorization_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationAgentAuthResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_agent_websocket_authorization_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConversationAgentAuthResponse**](ConversationAgentAuthResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_conversation
+
+> <Conversation> get_conversation(conversation_uuid)
+
+Retrieve a conversation
+
+Retrieve a conversation including the participants and messages 
+
+### 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_uuid = 'conversation_uuid_example' # String | 
+
+begin
+  # Retrieve a conversation
+  result = api_instance.get_conversation(conversation_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversation: #{e}"
+end
+```
+
+#### Using the get_conversation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Conversation>, Integer, Hash)> get_conversation_with_http_info(conversation_uuid)
+
+```ruby
+begin
+  # Retrieve a conversation
+  data, status_code, headers = api_instance.get_conversation_with_http_info(conversation_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Conversation>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_uuid** | **String** |  |  |
+
+### Return type
+
+[**Conversation**](Conversation.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_conversation_multimedia_upload_url
+
+> get_conversation_multimedia_upload_url(extension)
+
+Get a presigned conersation multimedia upload URL
+
+Get a presigned conersation multimedia upload URL 
+
+### 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)
+extension = 'extension_example' # String | 
+
+begin
+  # Get a presigned conersation multimedia upload URL
+  api_instance.get_conversation_multimedia_upload_url(extension)
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversation_multimedia_upload_url: #{e}"
+end
+```
+
+#### Using the get_conversation_multimedia_upload_url_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> get_conversation_multimedia_upload_url_with_http_info(extension)
+
+```ruby
+begin
+  # Get a presigned conersation multimedia upload URL
+  data, status_code, headers = api_instance.get_conversation_multimedia_upload_url_with_http_info(extension)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversation_multimedia_upload_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **extension** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_conversations
+
+> <ConversationsResponse> get_conversations(opts)
+
+Retrieve a list of conversation summaries newest to oldest
+
+Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read. 
+
+### 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)
+opts = {
+  _limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
+  _offset: 56 # Integer | Pagination of the record set.  Offset is a zero based index.
+}
+
+begin
+  # Retrieve a list of conversation summaries newest to oldest
+  result = api_instance.get_conversations(opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversations: #{e}"
+end
+```
+
+#### Using the get_conversations_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationsResponse>, Integer, Hash)> get_conversations_with_http_info(opts)
+
+```ruby
+begin
+  # Retrieve a list of conversation summaries newest to oldest
+  data, status_code, headers = api_instance.get_conversations_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversations_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
+| **_offset** | **Integer** | Pagination of the record set.  Offset is a zero based index. | [optional][default to 0] |
+
+### Return type
+
+[**ConversationsResponse**](ConversationsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## join_conversation
+
+> join_conversation(conversation_uuid)
+
+Join a conversation
+
+Join a conversation 
+
+### 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_uuid = 'conversation_uuid_example' # String | 
+
+begin
+  # Join a conversation
+  api_instance.join_conversation(conversation_uuid)
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->join_conversation: #{e}"
+end
+```
+
+#### Using the join_conversation_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> join_conversation_with_http_info(conversation_uuid)
+
+```ruby
+begin
+  # Join a conversation
+  data, status_code, headers = api_instance.join_conversation_with_http_info(conversation_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->join_conversation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_uuid** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## leave_conversation
+
+> leave_conversation(conversation_uuid)
+
+Leave a conversation
+
+Leave a conversation 
+
+### 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_uuid = 'conversation_uuid_example' # String | 
+
+begin
+  # Leave a conversation
+  api_instance.leave_conversation(conversation_uuid)
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->leave_conversation: #{e}"
+end
+```
+
+#### Using the leave_conversation_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> leave_conversation_with_http_info(conversation_uuid)
+
+```ruby
+begin
+  # Leave a conversation
+  data, status_code, headers = api_instance.leave_conversation_with_http_info(conversation_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->leave_conversation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_uuid** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## start_conversation
+
+> <ConversationStartResponse> start_conversation(start_request)
+
+Start a conversation
+
+Start a new conversation 
+
+### 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)
+start_request = UltracartClient::ConversationStartRequest.new # ConversationStartRequest | Start request
+
+begin
+  # Start a conversation
+  result = api_instance.start_conversation(start_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->start_conversation: #{e}"
+end
+```
+
+#### Using the start_conversation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationStartResponse>, Integer, Hash)> start_conversation_with_http_info(start_request)
+
+```ruby
+begin
+  # Start a conversation
+  data, status_code, headers = api_instance.start_conversation_with_http_info(start_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationStartResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->start_conversation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_request** | [**ConversationStartRequest**](ConversationStartRequest.md) | Start request |  |
+
+### Return type
+
+[**ConversationStartResponse**](ConversationStartResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+