ultracart_api 4.1.164 → 4.1.167

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/FraudApi.md

@@ -23,8 +23,25 @@ Adds one email address to the fraud decline list for this merchant account.
 
 ### Examples
 
+```ruby
+# frozen_string_literal: true
+
+require 'ultracart_api'
+require_relative '../constants'
+
+# decline_email is a shortcut for telling UltraCart to decline orders from a specific email
+# address.  It is the quick alternative to building a full "address email" fraud rule by hand.
+
+fraud_api = UltracartClient::FraudApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+decline_request = UltracartClient::FraudDeclineEmailRequest.new(
+  email: 'chargeback-charlie@example.com'
+)
 
-(No example for this operation).
+fraud_api.decline_email(decline_request)
+
+puts "Declined email: #{decline_request.email}"
+```
 
 
 #### Using the decline_email_with_http_info variant
@@ -76,8 +93,36 @@ Deletes a fraud rule for this merchant account.
 
 ### Examples
 
-
-(No example for this operation).
+```ruby
+# frozen_string_literal: true
+
+require 'ultracart_api'
+require_relative '../constants'
+
+# delete_fraud_rule removes a fraud rule by its oid.
+#
+# To keep this sample self-contained it first inserts a throwaway rule, then deletes it using
+# the oid returned from the insert.  In your own code you would already have the oid of the rule
+# you want to remove (for example from search_fraud_rules).
+
+fraud_api = UltracartClient::FraudApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+# Insert a rule so we have something to delete.
+rule = UltracartClient::FraudRuleInsertRequest.new(
+  rule_type: 'credit card single transaction exceeds',
+  amount_threshold: 2500.00,
+  failure_action: 'Flag For Review',
+  auto_note: 'Temporary rule created by the delete_fraud_rule sample'
+)
+
+insert_response = fraud_api.insert_fraud_rule(rule)
+fraud_rule_oid = insert_response.fraud_rule.fraud_rule_oid
+puts "Inserted temporary rule, oid = #{fraud_rule_oid}"
+
+# Now delete it.
+fraud_api.delete_fraud_rule(fraud_rule_oid)
+puts "Deleted fraud rule oid = #{fraud_rule_oid}"
+```
 
 
 #### Using the delete_fraud_rule_with_http_info variant
@@ -129,8 +174,42 @@ Creates one or more fraud rules for this merchant account derived from an existi
 
 ### Examples
 
-
-(No example for this operation).
+```ruby
+# frozen_string_literal: true
+
+require 'ultracart_api'
+require_relative '../constants'
+
+# establish_fraud_rules_from_order is a shortcut that derives fraud rules from an existing order.
+# Point it at an order you have identified as fraudulent and tell it which attributes of that
+# order to turn into rules: the email, the credit card, the ip address, and/or the address.
+# It creates the matching rules and returns them. This is the fast way to "block everything
+# associated with this bad order" instead of building each rule by hand.
+#
+# Not every filter produces a rule; the order must actually have that attribute. For example an
+# order with no stored card data will not produce a credit card rule.
+
+fraud_api = UltracartClient::FraudApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+request = UltracartClient::FraudRuleFromOrderRequest.new(
+  order_id: 'DEMO-0009104434',
+  establish_email_filter: true,
+  establish_card_filter: true,
+  establish_ip_filter: true,
+  establish_address_filter: true,
+  failure_action: 'Flag For Review',
+  auto_note: 'Established from fraudulent order DEMO-0009104434'
+)
+
+api_response = fraud_api.establish_fraud_rules_from_order(request)
+
+fraud_rules = api_response.fraud_rules
+puts "Established #{fraud_rules.length} rule(s) from the order:"
+
+fraud_rules.each do |fraud_rule|
+  puts "  oid #{fraud_rule.fraud_rule_oid} - #{fraud_rule.rule_type} - #{fraud_rule.auto_note}"
+end
+```
 
 
 #### Using the establish_fraud_rules_from_order_with_http_info variant
@@ -182,8 +261,34 @@ Returns the dropdown values required to build valid fraud rule insert and search
 
 ### Examples
 
+```ruby
+# frozen_string_literal: true
+
+require 'ultracart_api'
+require_relative '../constants'
+
+# get_fraud_lookup_values returns the lookup values used when building fraud rules:
+# the allowed countries, affiliates, ip range types, rule groups, and rule types.
+# Call this first when constructing a rule so you supply valid values.
+
+fraud_api = UltracartClient::FraudApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+api_response = fraud_api.get_fraud_lookup_values
 
-(No example for this operation).
+lookup_values = api_response.fraud_lookup_values
+
+puts 'Rule types:'
+puts lookup_values.rule_types.inspect
+
+puts 'Rule groups:'
+puts lookup_values.rule_groups.inspect
+
+puts 'IP range types:'
+puts lookup_values.ip_range_types.inspect
+
+puts 'Countries:'
+puts lookup_values.countries.inspect
+```
 
 
 #### Using the get_fraud_lookup_values_with_http_info variant
@@ -233,8 +338,79 @@ Creates a fraud rule for this merchant account. Field names in the request body
 
 ### Examples
 
-
-(No example for this operation).
+```ruby
+# frozen_string_literal: true
+
+require 'ultracart_api'
+require_relative '../constants'
+
+# insert_fraud_rule creates a single fraud rule.  Each rule has a rule_type (what it inspects),
+# a failure_action (what happens when it matches), and type-specific fields such as an amount
+# threshold, country code, ip address, or email.
+#
+# This sample has some fun and inserts several rules of different types in one run.  Call
+# get_fraud_lookup_values.rb to see every valid rule_type and the other lookup values.
+
+fraud_api = UltracartClient::FraudApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+rules = []
+
+# 1. Decline any order placed with a known-bad email address.
+rules << UltracartClient::FraudRuleInsertRequest.new(
+  rule_type: 'address email',
+  email: 'chargeback-charlie@example.com',
+  failure_action: 'Decline Transaction',
+  auto_note: 'Known chargeback email - decline on sight'
+)
+
+# 2. Flag large single credit card transactions over $1,000 for manual review.
+rules << UltracartClient::FraudRuleInsertRequest.new(
+  rule_type: 'credit card single transaction exceeds',
+  amount_threshold: 1000.00,
+  failure_action: 'Flag For Review',
+  auto_note: 'Large single transaction - review before shipping'
+)
+
+# 3. Decline orders that ship outside the United States.
+rules << UltracartClient::FraudRuleInsertRequest.new(
+  rule_type: 'address not in country',
+  country_code: 'US',
+  failure_action: 'Decline Transaction',
+  auto_note: 'Domestic shipping only'
+)
+
+# 4. Decline transactions originating from a specific bad IP address.
+rules << UltracartClient::FraudRuleInsertRequest.new(
+  rule_type: 'ip matches',
+  ip_address: '203.0.113.66',
+  ip_range_type: 'address',
+  failure_action: 'Decline Transaction',
+  auto_note: 'Blocked IP address'
+)
+
+# 5. Flag prepaid credit cards for review.
+rules << UltracartClient::FraudRuleInsertRequest.new(
+  rule_type: 'credit card block prepaid',
+  failure_action: 'Flag For Review',
+  auto_note: 'Prepaid card - take a closer look'
+)
+
+# 6. Flag a customer IP making more than 10 transactions in a single day.
+rules << UltracartClient::FraudRuleInsertRequest.new(
+  rule_type: 'ip daily transaction count exceeds',
+  count_threshold: 10,
+  ip_range_type: 'address',
+  user_action: 'Attempted',
+  failure_action: 'Flag For Review',
+  auto_note: 'IP velocity - more than 10 orders in a day'
+)
+
+rules.each do |rule|
+  api_response = fraud_api.insert_fraud_rule(rule)
+  created = api_response.fraud_rule
+  puts "Inserted '#{rule.rule_type}' rule, oid = #{created.fraud_rule_oid}"
+end
+```
 
 
 #### Using the insert_fraud_rule_with_http_info variant
@@ -286,8 +462,33 @@ Searches fraud rules for this merchant account using semantic filter fields. Pag
 
 ### Examples
 
+```ruby
+# frozen_string_literal: true
+
+require 'ultracart_api'
+require_relative '../constants'
+
+# search_fraud_rules returns the fraud rules that match the supplied criteria.  Every field on the
+# FraudRuleSearchRequest is optional; supply only the ones you want to filter on.  Pagination and
+# sort are passed as options (_limit, _offset, _sort).
+#
+# This sample searches for every rule whose action is "Decline Transaction".
+
+fraud_api = UltracartClient::FraudApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+
+search_request = UltracartClient::FraudRuleSearchRequest.new(
+  failure_action: 'Decline Transaction'
+)
 
-(No example for this operation).
+api_response = fraud_api.search_fraud_rules(search_request, { _limit: 200, _offset: 0 })
+
+fraud_rules = api_response.fraud_rules
+puts "Found #{fraud_rules.length} rule(s) with action 'Decline Transaction'"
+
+fraud_rules.each do |fraud_rule|
+  puts "  oid #{fraud_rule.fraud_rule_oid} - #{fraud_rule.rule_type} - #{fraud_rule.auto_note}"
+end
+```
 
 
 #### Using the search_fraud_rules_with_http_info variant

data/docs/GiftCertificateApi.md

@@ -470,10 +470,8 @@ api = UltracartClient::GiftCertificateApi.new_using_api_key(Constants::API_KEY,
 def get_gift_certificates_chuck(api, offset, limit)
   expansion = 'ledger'.freeze
   query = UltracartClient::GiftCertificateQuery.new # leaving this empty, so no filtering, and I should get all records returned.
-  api_response = api.get_gift_certificates_by_query(query, { _limit: limit, _offset: offset, _expand: expansion })
-  return api_response.gift_certificates unless api_response.gift_certificates.nil?
-
-  []
+  api_response = api.get_gift_certificates_by_query(query, { :'_limit' => limit, :'_offset' => offset, :'_expand' => expansion })
+  api_response.gift_certificates unless api_response.gift_certificates.nil? []
 end
 
 

data/docs/OrderApi.md

@@ -1300,8 +1300,48 @@ Retrieves the customer activity associated with the email address on this order.
 
 ### Examples
 
+```ruby
+require 'ultracart_api'
+require_relative '../constants'
 
-(No example for this operation).
+# getOrderCustomerActivity returns the customer activity associated with the email address on an order.
+# This includes email engagement history, email list and segment membership, lifetime metrics and email
+# suppression status.
+#
+# A customer profile is NOT required and is not consulted.  The activity is keyed off the email address on
+# the order, so this works for guest orders that have never had a customer profile established.  For the
+# page views captured during the session that placed the order, use get_order_page_view_history instead.
+#
+# If the order has no valid email address, email and customer_activity both come back nil.  That is a
+# successful response rather than an error - without an email there is no activity record to find.
+#
+# Note: activity.ts is a unix timestamp in milliseconds, not an ISO 8601 string like most dates in this API.
+#
+# Possible Errors:
+# order_id does not start with the merchant id -> "Path parameter 'order_id' does not start with the merchant id.  Check your parameter value and call log."
+order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
+
+order_id = 'DEMO-0009104976'
+
+begin
+  api_response = order_api.get_order_customer_activity(order_id)
+  customer_activity = api_response.customer_activity
+
+  puts "Customer activity for: #{api_response.email}"
+
+  if customer_activity.nil?
+    puts 'No customer activity found for this order.'
+  else
+    puts "Globally unsubscribed: #{customer_activity.global_unsubscribed}"
+    puts "Spam complaint: #{customer_activity.spam_complaint}"
+
+    # Using inspect instead of var_dump for Ruby-style object representation
+    puts customer_activity.activities.inspect
+  end
+rescue StandardError => e
+  puts "An error occurred: #{e.message}"
+end
+```
 
 
 #### Using the get_order_customer_activity_with_http_info variant
@@ -1426,8 +1466,52 @@ Retrieves email delivery records associated with the specified order id.
 
 ### Examples
 
+```ruby
+require 'ultracart_api'
+require_relative '../constants'
 
-(No example for this operation).
+# getOrderEmails returns the delivery records for every email UltraCart sent regarding an order, oldest
+# first.  Each record carries the subject and send time plus delivery, open, click and bounce status,
+# which makes this useful evidence that a customer was notified about their order.
+#
+# A customer profile is NOT required.  These records are tied to the order id itself.
+#
+# An order with no email history, or one whose emails were all suppressed, comes back with an empty emails
+# array.  That is a successful response rather than an error.
+#
+# The internal flag marks messages sent to merchant staff rather than to the customer.  Filter those out
+# if you only want what the customer actually received.
+#
+# Possible Errors:
+# order_id does not start with the merchant id -> "Path parameter 'order_id' does not start with the merchant id.  Check your parameter value and call log."
+order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
+
+order_id = 'DEMO-0009104976'
+
+begin
+  api_response = order_api.get_order_emails(order_id)
+  emails = api_response.emails || []
+
+  if emails.empty?
+    puts 'No emails were sent for this order.'
+  else
+    emails.each do |email|
+      puts "#{email.send_dts} - #{email.email} - #{email.subject}"
+
+      status = []
+      status << "delivered #{email.delivery_dts}" if email.delivered
+      status << "opened #{email.opened_dts}" if email.opened
+      status << "clicked #{email.clicked_dts}" if email.clicked
+      status << "skipped: #{email.skip_reason}" if email.skipped
+      status << "bounced #{email.bounce_type}/#{email.bounce_sub_type}" if email.bounce_type
+
+      puts "    #{status.empty? ? 'no delivery events recorded' : status.join(', ')}"
+    end
+  end
+rescue StandardError => e
+  puts "An error occurred: #{e.message}"
+end
+```
 
 
 #### Using the get_order_emails_with_http_info variant
@@ -1479,8 +1563,51 @@ Retrieves the page views captured during the session that placed this order.
 
 ### Examples
 
+```ruby
+require 'ultracart_api'
+require_relative '../constants'
 
-(No example for this operation).
+# getOrderPageViewHistory returns the page views captured during the session that placed an order, along
+# with the referrer that started that session.
+#
+# A customer profile is NOT required.  These page views are keyed off an analytics client id stored on the
+# order itself, so this works for guest orders.  For the email engagement side of customer activity, use
+# get_order_customer_activity instead.
+#
+# An order placed outside the storefront, such as a phone order or an order imported from a channel
+# partner, will have no analytics session attached.  In that case page_views comes back empty.  That is a
+# successful response rather than an error.
+#
+# Note: view_dts is an ISO 8601 string here.  Be aware that the ts field on get_order_customer_activity is
+# unix milliseconds instead, so do not assume the two methods format dates the same way.
+#
+# Possible Errors:
+# order_id does not start with the merchant id -> "Path parameter 'order_id' does not start with the merchant id.  Check your parameter value and call log."
+order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
+
+order_id = 'DEMO-0009104976'
+
+begin
+  api_response = order_api.get_order_page_view_history(order_id)
+  page_views = api_response.page_views || []
+
+  puts "Session referrer: #{api_response.referrer || '(none captured)'}"
+
+  if page_views.empty?
+    puts 'No page views were captured for this order.'
+  else
+    page_views.each do |page_view|
+      time_on_page = page_view.time_on_page ? " (#{page_view.time_on_page}s on page)" : ''
+      puts "#{page_view.view_dts} - #{page_view.url}#{time_on_page}"
+    end
+
+    # Using inspect instead of var_dump for Ruby-style object representation
+    puts page_views.inspect
+  end
+rescue StandardError => e
+  puts "An error occurred: #{e.message}"
+end
+```
 
 
 #### Using the get_order_page_view_history_with_http_info variant
@@ -2283,7 +2410,7 @@ begin
   cc_token = 'F893C8CBAE34830177F9EA9D97205400'
   cvv_token = '3FA7577E42F7580177F9EAA2FF1F5900'
 
-  get_response = checkout_api.get_cart(_expand: expansion)
+  get_response = checkout_api.get_cart({:'_expand' => expansion})
   if get_response.errors&.length&.positive?
     # handle errors here.
     abort('System error.  Could not retrieve shopping cart.')
@@ -2308,7 +2435,7 @@ begin
 
   # If the customer already has a customer profile, then load that profile and pull the shipping/billing from there.
   # otherwise populate it manually.
-  customer_response = customer_api.get_customer_by_email(email, { _expand: 'shipping,billing,cards' })
+  customer_response = customer_api.get_customer_by_email(email, { :'_expand' => 'shipping,billing,cards' })
   if customer_response&.customer
 
     cp = customer_response.customer # cp is short for 'customer profile'
@@ -2378,7 +2505,7 @@ begin
   # the optimal shipping method estimates and ensure that you don't error
   # by selecting a shipping method that is somehow excluded from the possible
   # list for whatever reason (restrictions, locations, item-level constraints, etc)
-  update_response = checkout_api.update_cart(cart, _expand: expansion)
+  update_response = checkout_api.update_cart(cart, {:'_expand' => expansion})
   cart = update_response.cart
 
   # for shipping, check the estimates and select one.  for a completely non-interactive checkout such as this,
@@ -2392,7 +2519,7 @@ begin
     end
   end
 
-  update_response = checkout_api.update_cart(cart, _expand: expansion)
+  update_response = checkout_api.update_cart(cart, {:'_expand' => expansion})
   cart = update_response.cart
 
   # validate the cart to ensure everything is in order.
@@ -2577,7 +2704,7 @@ expansion = "items"   # for this example, we're going to change the items after
 
 # Step 1. Duplicate the order
 order_id_to_duplicate = 'DEMO-0009104436'
-api_response = order_api.duplicate_order(order_id_to_duplicate, opts = { _expand: expansion })
+api_response = order_api.duplicate_order(order_id_to_duplicate, opts = { :'_expand' => expansion })
 new_order = api_response.order
 
 # Step 2. Update the items. I will create a new items array and assign it to the order to remove the old ones completely.
@@ -2600,7 +2727,7 @@ item.weight = weight
 
 items << item
 new_order.items = items
-update_response = order_api.update_order(new_order.order_id, new_order, opts = { _expand: expansion })
+update_response = order_api.update_order(new_order.order_id, new_order, opts = { :'_expand' => expansion })
 
 updated_order = update_response.order
 
@@ -2697,7 +2824,7 @@ expansion = "items"
 
 # Step 1. Retrieve the order
 order_id = 'DEMO-0009104436'
-order = order_api.get_order(order_id, opts = { _expand: expansion }).order
+order = order_api.get_order(order_id, opts = { :'_expand' => expansion }).order
 
 order.items.each do |item|
   item.quantity_refunded = item.quantity
@@ -3221,13 +3348,13 @@ order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
 expansion = "checkout" # see the get_order sample for expansion discussion
 
 order_id = 'DEMO-0009104976'
-order = order_api.get_order(order_id, opts = { _expand: expansion }).order
+order = order_api.get_order(order_id, opts = { :'_expand' => expansion }).order
 
 p order
 
 # TODO: do some updates to the order.
 
-api_response = order_api.update_order(order_id, order, opts = { _expand: expansion })
+api_response = order_api.update_order(order_id, order, opts = { :'_expand' => expansion })
 
 if api_response.error
   puts api_response.error.developer_message
@@ -3330,7 +3457,7 @@ order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
 expansion = "checkout" # see the get_order sample for expansion discussion
 
 order_id = 'DEMO-0009104976'
-order = order_api.get_order(order_id, opts = { _expand: expansion }).order
+order = order_api.get_order(order_id, opts = { :'_expand' => expansion }).order
 
 p order
 

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 |
@@ -1312,8 +1314,9 @@ Delete file manager directory
 
 ### Examples
 
+```ruby
 
-(No example for this operation).
+```
 
 
 #### Using the delete_fs_file_with_http_info variant
@@ -4549,6 +4552,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)
@@ -9398,8 +9507,9 @@ Update email sending domain
 
 ### Examples
 
+```ruby
 
-(No example for this operation).
+```
 
 
 #### Using the update_email_sending_domain_with_http_info variant