ultracart_api 3.10.19 → 3.10.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78041697c0613ab2caadfefb31ad7a5ed74ef26b644376b2c07d3d737ba32308
-  data.tar.gz: 87082c912aed8bece9e24491980059f8b6485d33b11ec69fdf923619c7313899
+  metadata.gz: 05722e44889d98eac4a8db4a0227dbbdc2469b7f727d73163c519669929de1a2
+  data.tar.gz: c3cd123c695a10b0febf241f82343e52c426df8726ce0dc7dbfdb7e3e1c60961
 SHA512:
-  metadata.gz: 2cdfd1a35882a63c43116c799cd4a2e2329dd13d4292796d67e85467fbfa027e245e589dd51a8ee991e9e170f02c66ed413e0e30a19827bf802f9192ca522561
-  data.tar.gz: 5ae21465d11beda5648a6b3363b671d671303ab5802d6f2709eee2411e4b2a42b67a1640ca20633daca5484e61207c8592e2c6a3325ff966b0fe9cfd209582ba
+  metadata.gz: 5374b87901b42001e7faadcd3d128bc1a5e60b8335427af72749745773ad0fa909f5b19638bee04173e8c3c304a7a1895dc5547832e5ba20503685eeb29becad
+  data.tar.gz: c3e2892579f7146cebdab8f6769ddc20e006f7eb7ce50cfdf7be19fb0e6a5cfa9b2271585c8a9f5f0904d3f488d4ba7146917b0ba59211e1939372126df91a6a

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.10.19
+- Package version: 3.10.22
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.10.19.gem
+gem install ./ultracart_api-3.10.22.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.19.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.22.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', '~> 3.10.19'
+    gem 'ultracart_api', '~> 3.10.22'
 
 ### Install from Git
 
@@ -125,6 +125,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
@@ -548,6 +555,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)
@@ -1095,6 +1111,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.
@@ -1134,6 +1152,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.22 | 07/20/2022 | conversation participant name added |
+| 3.10.21 | 07/18/2022 | twilio dev |
+| 3.10.20 | 07/14/2022 | Add channel storefront_oid to the customer activity record |
 | 3.10.19 | 07/11/2022 | Customer API - mergeCustomer method |
 | 3.10.18 | 06/23/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |
 | 3.10.17 | 06/23/2022 | automation test |

data/docs/Activity.md

@@ -4,7 +4,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] 

data/docs/Conversation.md

@@ -0,0 +1,12 @@
+# 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] 
+
+

data/docs/ConversationAgentAuthResponse.md

@@ -0,0 +1,13 @@
+# 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] 
+
+

data/docs/ConversationApi.md

@@ -0,0 +1,360 @@
+# 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. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+
+begin
+  #Get agent websocket authorization
+  result = api_instance.get_agent_websocket_authorization
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_agent_websocket_authorization: #{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**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_conversation**
+> Conversation get_conversation(conversation_uuid)
+
+Retrieve a conversation
+
+Retrieve a conversation including the participants and messages 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+conversation_uuid = 'conversation_uuid_example' # String | 
+
+
+begin
+  #Retrieve a conversation
+  result = api_instance.get_conversation(conversation_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_conversation: #{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**: application/json
+ - **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 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+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 "Exception when calling ConversationApi->get_conversation_multimedia_upload_url: #{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**: application/json
+ - **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. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+opts = { 
+  _limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
+  _offset: 0 # 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 "Exception when calling ConversationApi->get_conversations: #{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**: application/json
+ - **Accept**: application/json
+
+
+
+# **join_conversation**
+> join_conversation(conversation_uuid)
+
+Join a conversation
+
+Join a conversation 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+conversation_uuid = 'conversation_uuid_example' # String | 
+
+
+begin
+  #Join a conversation
+  api_instance.join_conversation(conversation_uuid)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->join_conversation: #{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**: application/json
+ - **Accept**: application/json
+
+
+
+# **leave_conversation**
+> leave_conversation(conversation_uuid)
+
+Leave a conversation
+
+Leave a conversation 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+conversation_uuid = 'conversation_uuid_example' # String | 
+
+
+begin
+  #Leave a conversation
+  api_instance.leave_conversation(conversation_uuid)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->leave_conversation: #{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**: application/json
+ - **Accept**: application/json
+
+
+
+# **start_conversation**
+> ConversationStartResponse start_conversation(start_request)
+
+Start a conversation
+
+Start a new conversation 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+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 "Exception when calling ConversationApi->start_conversation: #{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,13 @@
+# 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] 
+**transport_statuses** | [**Array<ConversationMessageTransportStatus>**](ConversationMessageTransportStatus.md) |  | [optional] 
+
+

data/docs/ConversationMessageTransportStatus.md

@@ -0,0 +1,9 @@
+# UltracartClient::ConversationMessageTransportStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation_participant_arn** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/ConversationParticipant.md

@@ -0,0 +1,14 @@
+# 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] 
+
+

data/docs/ConversationStartRequest.md

@@ -0,0 +1,9 @@
+# UltracartClient::ConversationStartRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**add_conversation_participant_arns** | **Array<String>** |  | [optional] 
+**conversation_arn** | **String** |  | [optional] 
+
+

data/docs/ConversationStartResponse.md

@@ -0,0 +1,9 @@
+# UltracartClient::ConversationStartResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation_arn** | **String** |  | [optional] 
+**conversation_uuid** | **String** |  | [optional] 
+
+

data/docs/ConversationSummary.md

@@ -0,0 +1,16 @@
+# 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] 
+
+

data/docs/ConversationsResponse.md

@@ -0,0 +1,12 @@
+# 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] 
+
+