ultracart_api 4.0.32.rc → 4.0.35.rc

data/docs/ConversationAgentAuthResponse.md

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

data/docs/ConversationApi.md

@@ -0,0 +1,438 @@
+# 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_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_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
+

data/docs/ConversationMessage.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **author_conversation_participant_arn** | **String** |  | [optional] |
+| **author_conversation_participant_name** | **String** |  | [optional] |
+| **body** | **String** |  | [optional] |
+| **media_urls** | **Array<String>** |  | [optional] |
+| **message_dts** | **String** | Message date/time | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationMessage.new(
+  author_conversation_participant_arn: null,
+  author_conversation_participant_name: null,
+  body: null,
+  media_urls: null,
+  message_dts: null
+)
+```
+

data/docs/ConversationParticipant.md

@@ -0,0 +1,30 @@
+# UltracartClient::ConversationParticipant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_participant_arn** | **String** |  | [optional] |
+| **conversation_participant_name** | **String** |  | [optional] |
+| **conversation_participant_uuid** | **String** |  | [optional] |
+| **joined_dts** | **String** | Joined conversation date/time | [optional] |
+| **last_message_dts** | **String** | Last message date/time | [optional] |
+| **left_dts** | **String** | Left conversation date/time | [optional] |
+| **status** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationParticipant.new(
+  conversation_participant_arn: null,
+  conversation_participant_name: null,
+  conversation_participant_uuid: null,
+  joined_dts: null,
+  last_message_dts: null,
+  left_dts: null,
+  status: null
+)
+```
+

data/docs/ConversationStartRequest.md

@@ -0,0 +1,20 @@
+# UltracartClient::ConversationStartRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **add_conversation_participant_arns** | **Array<String>** |  | [optional] |
+| **conversation_arn** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationStartRequest.new(
+  add_conversation_participant_arns: null,
+  conversation_arn: null
+)
+```
+

data/docs/ConversationStartResponse.md

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

data/docs/ConversationSummary.md

@@ -0,0 +1,34 @@
+# UltracartClient::ConversationSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_arn** | **String** |  | [optional] |
+| **conversation_uuid** | **String** |  | [optional] |
+| **last_conversation_message_body** | **String** |  | [optional] |
+| **last_conversation_participant_arn** | **String** |  | [optional] |
+| **last_conversation_participant_name** | **String** |  | [optional] |
+| **last_message_dts** | **String** | Last message date/time | [optional] |
+| **merchant_id** | **String** |  | [optional] |
+| **message_count** | **Integer** |  | [optional] |
+| **unread_messages** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationSummary.new(
+  conversation_arn: null,
+  conversation_uuid: null,
+  last_conversation_message_body: null,
+  last_conversation_participant_arn: null,
+  last_conversation_participant_name: null,
+  last_message_dts: null,
+  merchant_id: null,
+  message_count: null,
+  unread_messages: null
+)
+```
+

data/docs/ConversationsResponse.md

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