ultracart_api 4.0.63.rc → 4.0.65.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15484cd481220bf96f131fc0acecfeee27a83afa20836d4804198613d206d67b
-  data.tar.gz: 8654390b05267c0e34e5dc43e9c9d49facfa49b5e298a88069a21a62e22cf462
+  metadata.gz: f94d77f310c53ac9af806f040781f34087f78b1a16540c1f2c9782b61c37fc89
+  data.tar.gz: 0132a21aeaaf1460ce49512cb4349c434035fdb49346b074e134e97cc664d62b
 SHA512:
-  metadata.gz: 9d7cf627cbbca6e6a3b35f08fbaf70701185d9883dff012f3a62d95fa2520b2d5a0e9bfaff8bf1d2800fbf0f6f192399e800694b1225e9a0234cca6ba0ed6a44
-  data.tar.gz: d27642bc84c9af9c1461615825fa390860755f513e69cf9640e43351780bc1d8671cbe94c269f51648c5deff54090ef5cb87efe156417c13edf0616f7250d92a
+  metadata.gz: 6472c8c04811613a4e5cc130ffdf910baae4718fc790f2136153714afc2076cc043a65a754096fac91f91098ab161a92773933080250e6971cef17da50e6b9a8
+  data.tar.gz: 4d962e9e90745e87e4f710c32b9d5f7a83588a5e35073270810e3580f030c7dd79fb39fa431094974ac0f9ef790e4f210f9f5780609d7ce996f365d28a978b1b

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.63.rc
+- Package version: 4.0.65.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.63.rc.gem
+gem install ./ultracart_api-4.0.65.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.63.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.65.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.63.rc'
+    gem 'ultracart_api', '~> 4.0.65.rc'
 
 ### Install from Git
 
@@ -131,8 +131,10 @@ 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_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_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
@@ -197,12 +199,17 @@ Class | Method | HTTP request | Description
 *UltracartClient::IntegrationLogApi* | [**get_integration_log_file_pdf**](docs/IntegrationLogApi.md#get_integration_log_file_pdf) | **GET** /integration_log/query/{pk}/{sk}/{uuid}/pdf | Retrieve an integration log file converted to PDF
 *UltracartClient::IntegrationLogApi* | [**get_integration_log_summaries_query**](docs/IntegrationLogApi.md#get_integration_log_summaries_query) | **POST** /integration_log/summary/query | Retrieve integration log summaries
 *UltracartClient::IntegrationLogApi* | [**get_integration_logs_query**](docs/IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
+*UltracartClient::ItemApi* | [**delete_digital_item**](docs/ItemApi.md#delete_digital_item) | **DELETE** /item/digital_library/{digital_item_oid} | Delete a digital item, which is a file within the digital library, not an actual merchant item
 *UltracartClient::ItemApi* | [**delete_item**](docs/ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
+*UltracartClient::ItemApi* | [**get_digital_item**](docs/ItemApi.md#get_digital_item) | **GET** /item/digital_library/{digital_item_oid} | Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
+*UltracartClient::ItemApi* | [**get_digital_items**](docs/ItemApi.md#get_digital_items) | **GET** /item/digital_library | Retrieve digital items from the digital library which are digital files that may be attached to normal items
 *UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
 *UltracartClient::ItemApi* | [**get_item_by_merchant_item_id**](docs/ItemApi.md#get_item_by_merchant_item_id) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id
 *UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
 *UltracartClient::ItemApi* | [**get_pricing_tiers**](docs/ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
+*UltracartClient::ItemApi* | [**insert_digital_item**](docs/ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
 *UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
+*UltracartClient::ItemApi* | [**update_digital_item**](docs/ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
 *UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
 *UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
 *UltracartClient::ItemApi* | [**upload_temporary_multimedia**](docs/ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
@@ -578,6 +585,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationEventTyping](docs/ConversationEventTyping.md)
  - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
  - [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
+ - [UltracartClient::ConversationMessagesResponse](docs/ConversationMessagesResponse.md)
  - [UltracartClient::ConversationMultimediaUploadUrl](docs/ConversationMultimediaUploadUrl.md)
  - [UltracartClient::ConversationMultimediaUploadUrlResponse](docs/ConversationMultimediaUploadUrlResponse.md)
  - [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
@@ -859,6 +867,9 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ItemContentMultimediaThumbnail](docs/ItemContentMultimediaThumbnail.md)
  - [UltracartClient::ItemDigitalDelivery](docs/ItemDigitalDelivery.md)
  - [UltracartClient::ItemDigitalItem](docs/ItemDigitalItem.md)
+ - [UltracartClient::ItemDigitalItemPdfMeta](docs/ItemDigitalItemPdfMeta.md)
+ - [UltracartClient::ItemDigitalItemResponse](docs/ItemDigitalItemResponse.md)
+ - [UltracartClient::ItemDigitalItemsResponse](docs/ItemDigitalItemsResponse.md)
  - [UltracartClient::ItemEbay](docs/ItemEbay.md)
  - [UltracartClient::ItemEbayCategorySpecific](docs/ItemEbayCategorySpecific.md)
  - [UltracartClient::ItemEbayMarketListing](docs/ItemEbayMarketListing.md)
@@ -1194,6 +1205,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.65-RC | 09/22/2022 | testing digital file mgmt calls |
+| 4.0.64-RC | 09/19/2022 | conversations pagination |
 | 4.0.63-RC | 09/13/2022 | storefront comms - postcard tracking |
 | 4.0.62-RC | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
 | 4.0.61-RC | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |

data/docs/ConversationApi.md

@@ -4,8 +4,10 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**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_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 |
@@ -15,6 +17,73 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue |
 
 
+## get_agent_keep_alive
+
+> get_agent_keep_alive
+
+Agent keep alive
+
+Called periodically by the conversation API to keep the session alive. 
+
+### 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
+  # Agent keep alive
+  api_instance.get_agent_keep_alive
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_agent_keep_alive: #{e}"
+end
+```
+
+#### Using the get_agent_keep_alive_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_agent_keep_alive_with_http_info
+
+```ruby
+begin
+  # Agent keep alive
+  data, status_code, headers = api_instance.get_agent_keep_alive_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_agent_keep_alive_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### 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_agent_websocket_authorization
 
 > <ConversationAgentAuthResponse> get_agent_websocket_authorization
@@ -85,7 +154,7 @@ This endpoint does not need any parameter.
 
 ## get_conversation
 
-> <ConversationResponse> get_conversation(conversation_uuid)
+> <ConversationResponse> get_conversation(conversation_uuid, opts)
 
 Retrieve a conversation
 
@@ -106,10 +175,13 @@ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/
 
 api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
 conversation_uuid = 'conversation_uuid_example' # String | 
+opts = {
+  limit: 56 # Integer | 
+}
 
 begin
   # Retrieve a conversation
-  result = api_instance.get_conversation(conversation_uuid)
+  result = api_instance.get_conversation(conversation_uuid, opts)
   p result
 rescue UltracartClient::ApiError => e
   puts "Error when calling ConversationApi->get_conversation: #{e}"
@@ -120,12 +192,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<ConversationResponse>, Integer, Hash)> get_conversation_with_http_info(conversation_uuid)
+> <Array(<ConversationResponse>, Integer, Hash)> get_conversation_with_http_info(conversation_uuid, opts)
 
 ```ruby
 begin
   # Retrieve a conversation
-  data, status_code, headers = api_instance.get_conversation_with_http_info(conversation_uuid)
+  data, status_code, headers = api_instance.get_conversation_with_http_info(conversation_uuid, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <ConversationResponse>
@@ -139,6 +211,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **conversation_uuid** | **String** |  |  |
+| **limit** | **Integer** |  | [optional] |
 
 ### Return type
 
@@ -154,6 +227,83 @@ end
 - **Accept**: application/json
 
 
+## get_conversation_messages
+
+> <ConversationMessagesResponse> get_conversation_messages(conversation_uuid, since, opts)
+
+Retrieve conversation messages
+
+Retrieve conversation messages since a particular time 
+
+### 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 | 
+since = 789 # Integer | 
+opts = {
+  limit: 56 # Integer | 
+}
+
+begin
+  # Retrieve conversation messages
+  result = api_instance.get_conversation_messages(conversation_uuid, since, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversation_messages: #{e}"
+end
+```
+
+#### Using the get_conversation_messages_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationMessagesResponse>, Integer, Hash)> get_conversation_messages_with_http_info(conversation_uuid, since, opts)
+
+```ruby
+begin
+  # Retrieve conversation messages
+  data, status_code, headers = api_instance.get_conversation_messages_with_http_info(conversation_uuid, since, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationMessagesResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->get_conversation_messages_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_uuid** | **String** |  |  |
+| **since** | **Integer** |  |  |
+| **limit** | **Integer** |  | [optional] |
+
+### Return type
+
+[**ConversationMessagesResponse**](ConversationMessagesResponse.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
 
 > <ConversationMultimediaUploadUrlResponse> get_conversation_multimedia_upload_url(extension)

data/docs/ConversationMessagesResponse.md

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