ultracart_api 4.1.164 → 4.1.166

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a07e74c89bb3f392f3a3d107c4719e848ed7255db8538ec618700d4b00aa52b
-  data.tar.gz: 1c769f9fe97dc31ea43c72e68409a803e047ae3fec950c625bb094a9d58efb52
+  metadata.gz: 266c6007956d258a4240b14379ada7f14eaa2353428b8dba0e517e9447137b21
+  data.tar.gz: c70906cfe8fc4cc482e4262912f479df7ff51fe718eddb8e124c0cd2067e4e07
 SHA512:
-  metadata.gz: fbdfa53139af0ae8e7b0f052a30aafeff737a46386fe9b4e03add92d0f9bbcfd0f20b1cb32b2efd6c62a51aa11019329f12609fe637b3bfda7078177386e2101
-  data.tar.gz: 9bf3dc36345beef2102e9ecff8ba08abed1c87b098fb80917a5ba8abb4329f15ecbeb7479741aedaa52e88db173f34cfbdfd7c52a612319b43f997b5a151158d
+  metadata.gz: 2b5d76248013766630fb40ce05c9f9fe81eb09ab1ae75a02e640cda002c8f872136c0ffef8bcc28a3fa0c0fe5f51a8a43ee9d59c4d8cb7cc72fc853d41766059
+  data.tar.gz: 59b3956e2c8e68b8f917f20c155a8aa48c38d4e5e3056e568b28cf42c29db1a091e9e0cba611a5ffb9d228dbb77701b0e832a4f0a12c809ca5e338d5c691b160

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.164
+- Package version: 4.1.166
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.164'
+gem 'ultracart_api', '4.1.166'
 ```
 
 install:
@@ -628,6 +628,8 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**get_email_postcard**](docs/StorefrontApi.md#get_email_postcard) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Get email postcard
 *UltracartClient::StorefrontApi* | [**get_email_postcards**](docs/StorefrontApi.md#get_email_postcards) | **GET** /storefront/{storefront_oid}/email/postcards | Get email postcards
 *UltracartClient::StorefrontApi* | [**get_email_postcards_multiple**](docs/StorefrontApi.md#get_email_postcards_multiple) | **POST** /storefront/{storefront_oid}/email/postcards/multiple | Get email postcards multiple
+*UltracartClient::StorefrontApi* | [**get_email_review_status**](docs/StorefrontApi.md#get_email_review_status) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review_status | Get the review status of an email
+*UltracartClient::StorefrontApi* | [**get_email_review_statuses_multiple**](docs/StorefrontApi.md#get_email_review_statuses_multiple) | **POST** /storefront/{storefront_oid}/email/emails/review_status/multiple | Get the review status of multiple emails
 *UltracartClient::StorefrontApi* | [**get_email_segment**](docs/StorefrontApi.md#get_email_segment) | **GET** /storefront/{storefront_oid}/email/segments/{email_segment_uuid} | Get email segment
 *UltracartClient::StorefrontApi* | [**get_email_segment_customer_editor_url**](docs/StorefrontApi.md#get_email_segment_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers/{email_customer_uuid}/editor_url | Get email segment customers editor URL
 *UltracartClient::StorefrontApi* | [**get_email_segment_customers**](docs/StorefrontApi.md#get_email_segment_customers) | **GET** /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers | Get email segment customers
@@ -1289,6 +1291,10 @@ Class | Method | HTTP request | Description
  - [UltracartClient::EmailCommseq](docs/EmailCommseq.md)
  - [UltracartClient::EmailCommseqEmail](docs/EmailCommseqEmail.md)
  - [UltracartClient::EmailCommseqEmailResponse](docs/EmailCommseqEmailResponse.md)
+ - [UltracartClient::EmailCommseqEmailReviewStatus](docs/EmailCommseqEmailReviewStatus.md)
+ - [UltracartClient::EmailCommseqEmailReviewStatusResponse](docs/EmailCommseqEmailReviewStatusResponse.md)
+ - [UltracartClient::EmailCommseqEmailReviewStatusesRequest](docs/EmailCommseqEmailReviewStatusesRequest.md)
+ - [UltracartClient::EmailCommseqEmailReviewStatusesResponse](docs/EmailCommseqEmailReviewStatusesResponse.md)
  - [UltracartClient::EmailCommseqEmailSendTestRequest](docs/EmailCommseqEmailSendTestRequest.md)
  - [UltracartClient::EmailCommseqEmailSendTestResponse](docs/EmailCommseqEmailSendTestResponse.md)
  - [UltracartClient::EmailCommseqEmailsRequest](docs/EmailCommseqEmailsRequest.md)
@@ -2014,6 +2020,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.166 | 09/21/2026 | sfvb internal testing |
+| 4.1.165 | 09/21/2026 | automation testing |
 | 4.1.164 | 09/20/2026 | automation testing |
 | 4.1.163 | 09/20/2026 | automation testing |
 | 4.1.162 | 09/18/2026 | sdk automation testing |

data/docs/EmailCommseqEmailReviewStatus.md

@@ -0,0 +1,32 @@
+# UltracartClient::EmailCommseqEmailReviewStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **decided_dts** | **String** | Date the review was approved or rejected | [optional] |
+| **esp_commseq_email_review_uuid** | **String** | Review UUID | [optional] |
+| **esp_commseq_email_uuid** | **String** | Email communication sequence email UUID | [optional] |
+| **esp_commseq_uuid** | **String** | Email communication sequence UUID | [optional] |
+| **rejection_reason** | **String** | Why the email was rejected, and what to change. Only present when the state is rejected. | [optional] |
+| **requested_dts** | **String** | Date the review was requested | [optional] |
+| **state** | **String** | State of the review | [optional] |
+| **subject** | **String** | Subject of the email as it was reviewed | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::EmailCommseqEmailReviewStatus.new(
+  decided_dts: null,
+  esp_commseq_email_review_uuid: null,
+  esp_commseq_email_uuid: null,
+  esp_commseq_uuid: null,
+  rejection_reason: null,
+  requested_dts: null,
+  state: null,
+  subject: null
+)
+```
+

data/docs/EmailCommseqEmailReviewStatusResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::EmailCommseqEmailReviewStatusResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **review_status** | [**EmailCommseqEmailReviewStatus**](EmailCommseqEmailReviewStatus.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::EmailCommseqEmailReviewStatusResponse.new(
+  error: null,
+  metadata: null,
+  review_status: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/EmailCommseqEmailReviewStatusesRequest.md

@@ -0,0 +1,18 @@
+# UltracartClient::EmailCommseqEmailReviewStatusesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **esp_commseq_email_uuids** | **Array<String>** | Email communication sequence email UUIDs to return the review status of | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::EmailCommseqEmailReviewStatusesRequest.new(
+  esp_commseq_email_uuids: null
+)
+```
+

data/docs/EmailCommseqEmailReviewStatusesResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::EmailCommseqEmailReviewStatusesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **review_statuses** | [**Array<EmailCommseqEmailReviewStatus>**](EmailCommseqEmailReviewStatus.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::EmailCommseqEmailReviewStatusesResponse.new(
+  error: null,
+  metadata: null,
+  review_statuses: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/StorefrontApi.md

@@ -86,6 +86,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_email_postcard**](StorefrontApi.md#get_email_postcard) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Get email postcard |
 | [**get_email_postcards**](StorefrontApi.md#get_email_postcards) | **GET** /storefront/{storefront_oid}/email/postcards | Get email postcards |
 | [**get_email_postcards_multiple**](StorefrontApi.md#get_email_postcards_multiple) | **POST** /storefront/{storefront_oid}/email/postcards/multiple | Get email postcards multiple |
+| [**get_email_review_status**](StorefrontApi.md#get_email_review_status) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review_status | Get the review status of an email |
+| [**get_email_review_statuses_multiple**](StorefrontApi.md#get_email_review_statuses_multiple) | **POST** /storefront/{storefront_oid}/email/emails/review_status/multiple | Get the review status of multiple emails |
 | [**get_email_segment**](StorefrontApi.md#get_email_segment) | **GET** /storefront/{storefront_oid}/email/segments/{email_segment_uuid} | Get email segment |
 | [**get_email_segment_customer_editor_url**](StorefrontApi.md#get_email_segment_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers/{email_customer_uuid}/editor_url | Get email segment customers editor URL |
 | [**get_email_segment_customers**](StorefrontApi.md#get_email_segment_customers) | **GET** /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers | Get email segment customers |
@@ -4549,6 +4551,112 @@ end
 - **Accept**: application/json
 
 
+## get_email_review_status
+
+> <EmailCommseqEmailReviewStatusResponse> get_email_review_status(storefront_oid, commseq_email_uuid)
+
+Get the review status of an email
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_email_review_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailCommseqEmailReviewStatusResponse>, Integer, Hash)> get_email_review_status_with_http_info(storefront_oid, commseq_email_uuid)
+
+```ruby
+begin
+  # Get the review status of an email
+  data, status_code, headers = api_instance.get_email_review_status_with_http_info(storefront_oid, commseq_email_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailCommseqEmailReviewStatusResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling StorefrontApi->get_email_review_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **commseq_email_uuid** | **String** |  |  |
+
+### Return type
+
+[**EmailCommseqEmailReviewStatusResponse**](EmailCommseqEmailReviewStatusResponse.md)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_email_review_statuses_multiple
+
+> <EmailCommseqEmailReviewStatusesResponse> get_email_review_statuses_multiple(storefront_oid, email_commseq_email_review_statuses_request)
+
+Get the review status of multiple emails
+
+Returns one entry per requested email, in the order requested, so a caller polling a campaign does not have to reconcile a short response. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the get_email_review_statuses_multiple_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailCommseqEmailReviewStatusesResponse>, Integer, Hash)> get_email_review_statuses_multiple_with_http_info(storefront_oid, email_commseq_email_review_statuses_request)
+
+```ruby
+begin
+  # Get the review status of multiple emails
+  data, status_code, headers = api_instance.get_email_review_statuses_multiple_with_http_info(storefront_oid, email_commseq_email_review_statuses_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailCommseqEmailReviewStatusesResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling StorefrontApi->get_email_review_statuses_multiple_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storefront_oid** | **Integer** |  |  |
+| **email_commseq_email_review_statuses_request** | [**EmailCommseqEmailReviewStatusesRequest**](EmailCommseqEmailReviewStatusesRequest.md) | Request of email uuids |  |
+
+### Return type
+
+[**EmailCommseqEmailReviewStatusesResponse**](EmailCommseqEmailReviewStatusesResponse.md)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## get_email_segment
 
 > <EmailSegmentResponse> get_email_segment(storefront_oid, email_segment_uuid)

data/lib/ultracart_api/api/storefront_api.rb

@@ -5661,6 +5661,149 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get the review status of an email
+    # @param storefront_oid [Integer] 
+    # @param commseq_email_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [EmailCommseqEmailReviewStatusResponse]
+    def get_email_review_status(storefront_oid, commseq_email_uuid, opts = {})
+      data, _status_code, _headers = get_email_review_status_with_http_info(storefront_oid, commseq_email_uuid, opts)
+      data
+    end
+
+    # Get the review status of an email
+    # @param storefront_oid [Integer] 
+    # @param commseq_email_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailCommseqEmailReviewStatusResponse, Integer, Hash)>] EmailCommseqEmailReviewStatusResponse data, response status code and response headers
+    def get_email_review_status_with_http_info(storefront_oid, commseq_email_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_review_status ...'
+      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.get_email_review_status"
+      end
+      # verify the required parameter 'commseq_email_uuid' is set
+      if @api_client.config.client_side_validation && commseq_email_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'commseq_email_uuid' when calling StorefrontApi.get_email_review_status"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review_status'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_email_uuid' + '}', CGI.escape(commseq_email_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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EmailCommseqEmailReviewStatusResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.get_email_review_status",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_email_review_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get the review status of multiple emails
+    # Returns one entry per requested email, in the order requested, so a caller polling a campaign does not have to reconcile a short response. 
+    # @param storefront_oid [Integer] 
+    # @param email_commseq_email_review_statuses_request [EmailCommseqEmailReviewStatusesRequest] Request of email uuids
+    # @param [Hash] opts the optional parameters
+    # @return [EmailCommseqEmailReviewStatusesResponse]
+    def get_email_review_statuses_multiple(storefront_oid, email_commseq_email_review_statuses_request, opts = {})
+      data, _status_code, _headers = get_email_review_statuses_multiple_with_http_info(storefront_oid, email_commseq_email_review_statuses_request, opts)
+      data
+    end
+
+    # Get the review status of multiple emails
+    # Returns one entry per requested email, in the order requested, so a caller polling a campaign does not have to reconcile a short response. 
+    # @param storefront_oid [Integer] 
+    # @param email_commseq_email_review_statuses_request [EmailCommseqEmailReviewStatusesRequest] Request of email uuids
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailCommseqEmailReviewStatusesResponse, Integer, Hash)>] EmailCommseqEmailReviewStatusesResponse data, response status code and response headers
+    def get_email_review_statuses_multiple_with_http_info(storefront_oid, email_commseq_email_review_statuses_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_review_statuses_multiple ...'
+      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.get_email_review_statuses_multiple"
+      end
+      # verify the required parameter 'email_commseq_email_review_statuses_request' is set
+      if @api_client.config.client_side_validation && email_commseq_email_review_statuses_request.nil?
+        fail ArgumentError, "Missing the required parameter 'email_commseq_email_review_statuses_request' when calling StorefrontApi.get_email_review_statuses_multiple"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/emails/review_status/multiple'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.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_email_review_statuses_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EmailCommseqEmailReviewStatusesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.get_email_review_statuses_multiple",
+        :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#get_email_review_statuses_multiple\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get email segment
     # @param storefront_oid [Integer] 
     # @param email_segment_uuid [String]