ultracart_api 4.0.46.rc → 4.0.49.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4c7d4822487ec085841c0d83f804da6abddd29d452748e8a8980a4f484c5291
-  data.tar.gz: 6019ba6c31b76725899b5f3d4eb8ecffe81670bed4e884019082ff28f7804184
+  metadata.gz: b21232f4f3169a87005e158e4cc3d4471098bda6b3759bc1817a9b7bf3bcf37c
+  data.tar.gz: 9e08a6150ec2fb2d1051fa746a70b25fb7f216b070924f248dace927b85278f2
 SHA512:
-  metadata.gz: 12f3a476da68e2dd38de7020d3b34dd5e7cf569d5661263f5b1b7b1be156f6a3eb5210ceef60c4b7dee0c5be2c158743fce74c42fee39fe90431e88360c6b3e0
-  data.tar.gz: 5859895fb72021511517767f0120a2fd8d4f30a1810d397cbee215e6eb9b44ba8a226b67a9a1d6da24dd131abacda46d7a7078ca2487596acfed892a149dc66a
+  metadata.gz: 5c5cfc69ce8da5fa375ba5477f84e4990156f7fd8cc5501f316e2d794438e9bc0cd0c9ff58e9c1dfd4391d701ebb19aface2b33a1e8f9b923d6af38d72ad42ba
+  data.tar.gz: 5eb966eaed532b56a06cff6362b24d3882953ea6566ea56fd3679ba1ba2491468a9cfa67caaf2d0b2457aa2c71f2f9144742afdd1fb16b398a0e558548074feb

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.46.rc
+- Package version: 4.0.49.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.46.rc.gem
+gem install ./ultracart_api-4.0.49.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.46.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.49.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.46.rc'
+    gem 'ultracart_api', '~> 4.0.49.rc'
 
 ### Install from Git
 
@@ -370,6 +370,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**send_email_test**](docs/StorefrontApi.md#send_email_test) | **POST** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test | Send email test
 *UltracartClient::StorefrontApi* | [**send_postcard_test**](docs/StorefrontApi.md#send_postcard_test) | **POST** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/test | Send postcard test
 *UltracartClient::StorefrontApi* | [**send_webhook_test**](docs/StorefrontApi.md#send_webhook_test) | **POST** /storefront/{storefront_oid}/email/webhooks/test | Send webhook test
+*UltracartClient::StorefrontApi* | [**sequence_test**](docs/StorefrontApi.md#sequence_test) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/test | Sequence test
 *UltracartClient::StorefrontApi* | [**start_email_campaign**](docs/StorefrontApi.md#start_email_campaign) | **PUT** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start | Start email campaign
 *UltracartClient::StorefrontApi* | [**subscribe_to_email_list**](docs/StorefrontApi.md#subscribe_to_email_list) | **POST** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe | Subscribe customers to email list
 *UltracartClient::StorefrontApi* | [**unfavorite_screen_recording**](docs/StorefrontApi.md#unfavorite_screen_recording) | **DELETE** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Remove favorite flag on screen recording
@@ -568,6 +569,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
  - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
  - [UltracartClient::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
+ - [UltracartClient::ConversationEventRRWeb](docs/ConversationEventRRWeb.md)
+ - [UltracartClient::ConversationEventTyping](docs/ConversationEventTyping.md)
  - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
  - [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
  - [UltracartClient::ConversationMultimediaUploadUrl](docs/ConversationMultimediaUploadUrl.md)
@@ -706,6 +709,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::EmailCommseqPostcardsRequest](docs/EmailCommseqPostcardsRequest.md)
  - [UltracartClient::EmailCommseqPostcardsResponse](docs/EmailCommseqPostcardsResponse.md)
  - [UltracartClient::EmailCommseqResponse](docs/EmailCommseqResponse.md)
+ - [UltracartClient::EmailCommseqSequenceTestRequest](docs/EmailCommseqSequenceTestRequest.md)
+ - [UltracartClient::EmailCommseqSequenceTestResponse](docs/EmailCommseqSequenceTestResponse.md)
  - [UltracartClient::EmailCommseqStat](docs/EmailCommseqStat.md)
  - [UltracartClient::EmailCommseqStatResponse](docs/EmailCommseqStatResponse.md)
  - [UltracartClient::EmailCommseqStep](docs/EmailCommseqStep.md)
@@ -1175,6 +1180,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.49-RC | 08/03/2022 | more conversation events |
+| 4.0.48-RC | 08/02/2022 | storefront communication sequence test method |
+| 4.0.47-RC | 08/01/2022 | conversation event refinement |
 | 4.0.46-RC | 07/29/2022 | conversation development |
 | 4.0.45-RC | 07/28/2022 | conversation bug fixes |
 | 4.0.44-RC | 07/28/2022 | conversation message upload keys property |

data/docs/ConversationEventRRWeb.md

@@ -0,0 +1,30 @@
+# UltracartClient::ConversationEventRRWeb
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **String** |  | [optional] |
+| **data_part** | **Integer** |  | [optional] |
+| **data_sha256** | **String** |  | [optional] |
+| **data_total_parts** | **Integer** |  | [optional] |
+| **data_total_sha256** | **String** |  | [optional] |
+| **event_index** | **Integer** |  | [optional] |
+| **type** | **String** | Type of event | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationEventRRWeb.new(
+  data: null,
+  data_part: null,
+  data_sha256: null,
+  data_total_parts: null,
+  data_total_sha256: null,
+  event_index: null,
+  type: null
+)
+```
+

data/docs/ConversationEventTyping.md

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

data/docs/ConversationMessage.md

@@ -11,6 +11,7 @@
 | **media_urls** | **Array<String>** |  | [optional] |
 | **message_dts** | **String** | Message date/time | [optional] |
 | **transport_statuses** | [**Array<ConversationMessageTransportStatus>**](ConversationMessageTransportStatus.md) |  | [optional] |
+| **type** | **String** | Message type | [optional] |
 | **upload_keys** | **Array<String>** |  | [optional] |
 
 ## Example
@@ -26,6 +27,7 @@ instance = UltracartClient::ConversationMessage.new(
   media_urls: null,
   message_dts: null,
   transport_statuses: null,
+  type: null,
   upload_keys: null
 )
 ```

data/docs/ConversationWebsocketMessage.md

@@ -10,7 +10,9 @@
 | **event_new_message** | [**ConversationSummary**](ConversationSummary.md) |  | [optional] |
 | **event_queue_position** | [**ConversationEventQueuePosition**](ConversationEventQueuePosition.md) |  | [optional] |
 | **event_queue_status_update** | [**ConversationWebchatQueueStatus**](ConversationWebchatQueueStatus.md) |  | [optional] |
+| **event_rrweb** | [**ConversationEventRRWeb**](ConversationEventRRWeb.md) |  | [optional] |
 | **event_type** | **String** | Type of event | [optional] |
+| **event_typing** | [**ConversationEventTyping**](ConversationEventTyping.md) |  | [optional] |
 | **event_updated_message** | [**ConversationMessage**](ConversationMessage.md) |  | [optional] |
 | **message** | [**ConversationMessage**](ConversationMessage.md) |  | [optional] |
 | **type** | **String** | Type of message | [optional] |
@@ -27,7 +29,9 @@ instance = UltracartClient::ConversationWebsocketMessage.new(
   event_new_message: null,
   event_queue_position: null,
   event_queue_status_update: null,
+  event_rrweb: null,
   event_type: null,
+  event_typing: null,
   event_updated_message: null,
   message: null,
   type: null

data/docs/EmailCommseqSequenceTestRequest.md

@@ -0,0 +1,32 @@
+# UltracartClient::EmailCommseqSequenceTestRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cart_id** | **String** |  | [optional] |
+| **cart_item_ids** | **Array<String>** |  | [optional] |
+| **esp_commseq_uuid** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **order_id** | **String** |  | [optional] |
+| **please_review** | **Boolean** |  | [optional] |
+| **send_to_email** | **String** |  | [optional] |
+| **send_to_logged_in_user** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::EmailCommseqSequenceTestRequest.new(
+  cart_id: null,
+  cart_item_ids: null,
+  esp_commseq_uuid: null,
+  name: null,
+  order_id: null,
+  please_review: null,
+  send_to_email: null,
+  send_to_logged_in_user: null
+)
+```
+

data/docs/EmailCommseqSequenceTestResponse.md

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

data/docs/StorefrontApi.md

@@ -140,6 +140,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**send_email_test**](StorefrontApi.md#send_email_test) | **POST** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test | Send email test |
 | [**send_postcard_test**](StorefrontApi.md#send_postcard_test) | **POST** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/test | Send postcard test |
 | [**send_webhook_test**](StorefrontApi.md#send_webhook_test) | **POST** /storefront/{storefront_oid}/email/webhooks/test | Send webhook test |
+| [**sequence_test**](StorefrontApi.md#sequence_test) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/test | Sequence test |
 | [**start_email_campaign**](StorefrontApi.md#start_email_campaign) | **PUT** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start | Start email campaign |
 | [**subscribe_to_email_list**](StorefrontApi.md#subscribe_to_email_list) | **POST** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe | Subscribe customers to email list |
 | [**unfavorite_screen_recording**](StorefrontApi.md#unfavorite_screen_recording) | **DELETE** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Remove favorite flag on screen recording |
@@ -9911,6 +9912,79 @@ end
 - **Accept**: application/json
 
 
+## sequence_test
+
+> <EmailCommseqSequenceTestResponse> sequence_test(storefront_oid, commseq_uuid, email_commseq_sequence_test_request)
+
+Sequence test
+
+### 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::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+storefront_oid = 56 # Integer | 
+commseq_uuid = 'commseq_uuid_example' # String | 
+email_commseq_sequence_test_request = UltracartClient::EmailCommseqSequenceTestRequest.new # EmailCommseqSequenceTestRequest | Commseq test request
+
+begin
+  # Sequence test
+  result = api_instance.sequence_test(storefront_oid, commseq_uuid, email_commseq_sequence_test_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling StorefrontApi->sequence_test: #{e}"
+end
+```
+
+#### Using the sequence_test_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailCommseqSequenceTestResponse>, Integer, Hash)> sequence_test_with_http_info(storefront_oid, commseq_uuid, email_commseq_sequence_test_request)
+
+```ruby
+begin
+  # Sequence test
+  data, status_code, headers = api_instance.sequence_test_with_http_info(storefront_oid, commseq_uuid, email_commseq_sequence_test_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailCommseqSequenceTestResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling StorefrontApi->sequence_test_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **commseq_uuid** | **String** |  |  |
+| **email_commseq_sequence_test_request** | [**EmailCommseqSequenceTestRequest**](EmailCommseqSequenceTestRequest.md) | Commseq test request |  |
+
+### Return type
+
+[**EmailCommseqSequenceTestResponse**](EmailCommseqSequenceTestResponse.md)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## start_email_campaign
 
 > <BaseResponse> start_email_campaign(storefront_oid, email_campaign_uuid)

data/lib/ultracart_api/api/storefront_api.rb

@@ -9412,6 +9412,85 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Sequence test
+    # @param storefront_oid [Integer] 
+    # @param commseq_uuid [String] 
+    # @param email_commseq_sequence_test_request [EmailCommseqSequenceTestRequest] Commseq test request
+    # @param [Hash] opts the optional parameters
+    # @return [EmailCommseqSequenceTestResponse]
+    def sequence_test(storefront_oid, commseq_uuid, email_commseq_sequence_test_request, opts = {})
+      data, _status_code, _headers = sequence_test_with_http_info(storefront_oid, commseq_uuid, email_commseq_sequence_test_request, opts)
+      data
+    end
+
+    # Sequence test
+    # @param storefront_oid [Integer] 
+    # @param commseq_uuid [String] 
+    # @param email_commseq_sequence_test_request [EmailCommseqSequenceTestRequest] Commseq test request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailCommseqSequenceTestResponse, Integer, Hash)>] EmailCommseqSequenceTestResponse data, response status code and response headers
+    def sequence_test_with_http_info(storefront_oid, commseq_uuid, email_commseq_sequence_test_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.sequence_test ...'
+      end
+      # verify the required parameter 'storefront_oid' is set
+      if @api_client.config.client_side_validation && storefront_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.sequence_test"
+      end
+      # verify the required parameter 'commseq_uuid' is set
+      if @api_client.config.client_side_validation && commseq_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.sequence_test"
+      end
+      # verify the required parameter 'email_commseq_sequence_test_request' is set
+      if @api_client.config.client_side_validation && email_commseq_sequence_test_request.nil?
+        fail ArgumentError, "Missing the required parameter 'email_commseq_sequence_test_request' when calling StorefrontApi.sequence_test"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/test'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_sequence_test_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EmailCommseqSequenceTestResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.sequence_test",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#sequence_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Start email campaign
     # @param storefront_oid [Integer] 
     # @param email_campaign_uuid [String]