ultracart_api 3.2.13 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0f63c103694ce036268067312ece0840cd6e4ce5bbe1b11456385fb6e88a943
-  data.tar.gz: 60a7abab5bc8d07865482a1e421f351c240fe2eec6f5c1f792c7a5325237d97a
+  metadata.gz: 973e1851cbd7dd1d0481726fd57f45fe46eab86d9e89543166aeaca494827159
+  data.tar.gz: 210b313bd8f49860508a69095f369c2ff050f1eb7312933479207eb8c29877a0
 SHA512:
-  metadata.gz: a8e4844ca4bee069ccfb372757a6ce80bf41fc6d4eb82d55ff38154dc1659dc081f0e2eef6d15deb670db872bc8315082d0363b310681fcbb4a7309bbad5605c
-  data.tar.gz: 29730e090b88d4c6357a415cd6a75517cd9e7e3bc7fcec795e161c615cf6379e4667986ba6535b06174dde3a55c700bb3bb2d52071e88e2722c4c62a3dfd3043
+  metadata.gz: 0224b0f76d1132f9873e8d36895c36b3cdc78602fac467c3f72517aaecca72d70d215e761a5d04b3bf3ed86b80cf7a8661186996a4b29c0dbd96051f33705137
+  data.tar.gz: bbdd9dfdf2136259e2a468752a1239d3a271fa59edb54ac61313b4650f5eaeeb05798549a0555ddbc6a4289906068d57f6848e10641963a9447582952d47c470

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.2.13
+- Package version: 3.3.1
 - 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.2.13.gem
+gem install ./ultracart_api-3.3.1.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.2.13.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.3.1.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.2.13'
+    gem 'ultracart_api', '~> 3.3.1'
 
 ### Install from Git
 
@@ -177,7 +177,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::OrderApi* | [**delete_order**](docs/OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
 *UltracartClient::OrderApi* | [**format**](docs/OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order
 *UltracartClient::OrderApi* | [**generate_order_token**](docs/OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id
-*UltracartClient::OrderApi* | [**generate_packing_slip_all_dc**](docs/OrderApi.md#generate_packing_slip_all_dc) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order for the given distribution center.
+*UltracartClient::OrderApi* | [**generate_packing_slip_all_dc**](docs/OrderApi.md#generate_packing_slip_all_dc) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order across all distribution centers.
 *UltracartClient::OrderApi* | [**generate_packing_slip_specific_dc**](docs/OrderApi.md#generate_packing_slip_specific_dc) | **GET** /order/orders/{order_id}/packing_slip/{distribution_center_code} | Generate a packing slip for this order for the given distribution center.
 *UltracartClient::OrderApi* | [**get_accounts_receivable_retry_config**](docs/OrderApi.md#get_accounts_receivable_retry_config) | **GET** /order/accountsReceivableRetryConfig | Retrieve A/R Retry Configuration
 *UltracartClient::OrderApi* | [**get_accounts_receivable_retry_stats**](docs/OrderApi.md#get_accounts_receivable_retry_stats) | **GET** /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics
@@ -194,6 +194,10 @@ Class | Method | HTTP request | Description
 *UltracartClient::OrderApi* | [**resend_shipment_confirmation**](docs/OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
 *UltracartClient::OrderApi* | [**update_accounts_receivable_retry_config**](docs/OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration
 *UltracartClient::OrderApi* | [**update_order**](docs/OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order
+*UltracartClient::SsoApi* | [**get_sso_session_user**](docs/SsoApi.md#get_sso_session_user) | **GET** /sso/session/user | Get single sign on session user
+*UltracartClient::SsoApi* | [**sso_authorize**](docs/SsoApi.md#sso_authorize) | **PUT** /sso/authorize | Authorize a single sign on session
+*UltracartClient::SsoApi* | [**sso_session_revoke**](docs/SsoApi.md#sso_session_revoke) | **DELETE** /sso/session/revoke | Revoke single sign on session
+*UltracartClient::SsoApi* | [**sso_token**](docs/SsoApi.md#sso_token) | **PUT** /sso/token | Exchange a single sign on code for a simple key token
 *UltracartClient::StorefrontApi* | [**add_to_library**](docs/StorefrontApi.md#add_to_library) | **POST** /storefront/code_library | Add to library
 *UltracartClient::StorefrontApi* | [**apply_to_store_front**](docs/StorefrontApi.md#apply_to_store_front) | **POST** /storefront/code_library/apply | Apply library item to storefront.
 *UltracartClient::StorefrontApi* | [**archive_email_list**](docs/StorefrontApi.md#archive_email_list) | **POST** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/archive | Archive email list
@@ -238,6 +242,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**get_email_customers**](docs/StorefrontApi.md#get_email_customers) | **GET** /storefront/{storefront_oid}/email/customers | Get email customers
 *UltracartClient::StorefrontApi* | [**get_email_dashboard_activity**](docs/StorefrontApi.md#get_email_dashboard_activity) | **GET** /storefront/{storefront_oid}/email/dashboard_activity | Get email dashboard activity
 *UltracartClient::StorefrontApi* | [**get_email_dashboard_stats**](docs/StorefrontApi.md#get_email_dashboard_stats) | **GET** /storefront/{storefront_oid}/email/dashboard_stats | Get dashboard stats
+*UltracartClient::StorefrontApi* | [**get_email_dispatch_logs**](docs/StorefrontApi.md#get_email_dispatch_logs) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/logs | Get email dispatch logs
 *UltracartClient::StorefrontApi* | [**get_email_email**](docs/StorefrontApi.md#get_email_email) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Get email email
 *UltracartClient::StorefrontApi* | [**get_email_email_clicks**](docs/StorefrontApi.md#get_email_email_clicks) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/clicks | Get email email clicks
 *UltracartClient::StorefrontApi* | [**get_email_email_customer_editor_url**](docs/StorefrontApi.md#get_email_email_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/orders/{order_id}/editor_url | Get email order customer editor url
@@ -610,6 +615,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::EmailCommseqStat](docs/EmailCommseqStat.md)
  - [UltracartClient::EmailCommseqStatResponse](docs/EmailCommseqStatResponse.md)
  - [UltracartClient::EmailCommseqStep](docs/EmailCommseqStep.md)
+ - [UltracartClient::EmailCommseqStepLog](docs/EmailCommseqStepLog.md)
+ - [UltracartClient::EmailCommseqStepLogsResponse](docs/EmailCommseqStepLogsResponse.md)
  - [UltracartClient::EmailCommseqsResponse](docs/EmailCommseqsResponse.md)
  - [UltracartClient::EmailCustomer](docs/EmailCustomer.md)
  - [UltracartClient::EmailCustomerEditorUrlResponse](docs/EmailCustomerEditorUrlResponse.md)
@@ -918,6 +925,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ScreenshotsResponse](docs/ScreenshotsResponse.md)
  - [UltracartClient::SelfConfig](docs/SelfConfig.md)
  - [UltracartClient::SimpleValue](docs/SimpleValue.md)
+ - [UltracartClient::SingleSignOnAuthorizeRequest](docs/SingleSignOnAuthorizeRequest.md)
+ - [UltracartClient::SingleSignOnTokenRequest](docs/SingleSignOnTokenRequest.md)
  - [UltracartClient::SovosConfig](docs/SovosConfig.md)
  - [UltracartClient::StateProvince](docs/StateProvince.md)
  - [UltracartClient::StepWaiting](docs/StepWaiting.md)
@@ -1035,7 +1044,11 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
-| 3.2.12 | 07/09/2021 | coupon api - added hideFromCustomer flag | 
+| 3.3.1 | 07/16/2021 | screen recording - event sub text used for assisting in UX rendering | 
+| 3.3.0 | 07/16/2021 | new endpoint SingleSignOn | 
+| 3.2.15 | 07/13/2021 | storefront communications - added methods to retrieve step dispatch logs | 
+| 3.2.14 | 07/12/2021 | fix documentation bug on packing slip methods for order api | 
+| 3.2.13 | 07/12/2021 | coupon api - added hideFromCustomer flag | 
 | 3.2.12 | 07/09/2021 | new fulfillment and order methods for generation of packing slips | 
 | 3.2.11 | 07/08/2021 | screen recording - missing external tracking flag added | 
 | 3.2.10 | 07/08/2021 | customer profile - allow drop shipping options | 

data/docs/EmailCommseqStepLog.md

@@ -0,0 +1,10 @@
+# UltracartClient::EmailCommseqStepLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email | [optional] 
+**log** | **String** | Log text | [optional] 
+**log_dts** | **String** | Log date/time | [optional] 
+
+

data/docs/EmailCommseqStepLogsResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::EmailCommseqStepLogsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**logs** | [**Array<EmailCommseqStepLog>**](EmailCommseqStepLog.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/OrderApi.md

@@ -9,7 +9,7 @@ Method | HTTP request | Description
 [**delete_order**](OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
 [**format**](OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order
 [**generate_order_token**](OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id
-[**generate_packing_slip_all_dc**](OrderApi.md#generate_packing_slip_all_dc) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order for the given distribution center.
+[**generate_packing_slip_all_dc**](OrderApi.md#generate_packing_slip_all_dc) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order across all distribution centers.
 [**generate_packing_slip_specific_dc**](OrderApi.md#generate_packing_slip_specific_dc) | **GET** /order/orders/{order_id}/packing_slip/{distribution_center_code} | Generate a packing slip for this order for the given distribution center.
 [**get_accounts_receivable_retry_config**](OrderApi.md#get_accounts_receivable_retry_config) | **GET** /order/accountsReceivableRetryConfig | Retrieve A/R Retry Configuration
 [**get_accounts_receivable_retry_stats**](OrderApi.md#get_accounts_receivable_retry_stats) | **GET** /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics
@@ -286,7 +286,7 @@ Name | Type | Description  | Notes
 # **generate_packing_slip_all_dc**
 > OrdersResponse generate_packing_slip_all_dc(order_id)
 
-Generate a packing slip for this order for the given distribution center.
+Generate a packing slip for this order across all distribution centers.
 
 The packing slip PDF that is returned is base 64 encoded 
 
@@ -304,7 +304,7 @@ order_id = 'order_id_example' # String | Order ID
 
 
 begin
-  #Generate a packing slip for this order for the given distribution center.
+  #Generate a packing slip for this order across all distribution centers.
   result = api_instance.generate_packing_slip_all_dc(order_id)
   p result
 rescue UltracartClient::ApiError => e

data/docs/OrderCoupon.md

@@ -7,5 +7,6 @@ Name | Type | Description | Notes
 **automatically_applied** | **BOOLEAN** | Whether or not the coupon was automatically applied to the order | [optional] 
 **base_coupon_code** | **String** | Coupon code configured by the merchant.  Will differ if the customer used a one time coupon code generated off this base coupon | [optional] 
 **coupon_code** | **String** | Coupon code entered by the customer | [optional] 
+**hdie_from_customer** | **BOOLEAN** | True if this coupon is hidde from the customer | [optional] 
 
 

data/docs/ScreenRecordingPageViewEvent.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **name** | **String** |  | [optional] 
 **params** | [**Array<ScreenRecordingPageViewEventParameter>**](ScreenRecordingPageViewEventParameter.md) |  | [optional] 
 **prior_page_view** | **BOOLEAN** |  | [optional] 
+**sub_text** | **String** |  | [optional] 
 **timestamp** | **String** | Timestamp of the event | [optional] 
 **ts** | **Integer** |  | [optional] 
 

data/docs/SingleSignOnAuthorizeRequest.md

@@ -0,0 +1,9 @@
+# UltracartClient::SingleSignOnAuthorizeRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redirect_uri** | **String** | The URL that the customer should be redirected to after they have approved a single sign on session. | [optional] 
+**state** | **String** | An optional state variable that you provide.  It will be returned to you on the redirect.  You can inspect the state to validate the request is legitimate.  We recommend using this field. | [optional] 
+
+

data/docs/SingleSignOnTokenRequest.md

@@ -0,0 +1,9 @@
+# UltracartClient::SingleSignOnTokenRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | The code received on the redirect URI after the customer approved the single sign on request. | [optional] 
+**grant_type** | **String** | Grant type.  The value should be simple_key. | [optional] 
+
+

data/docs/SsoApi.md

@@ -0,0 +1,201 @@
+# UltracartClient::SsoApi
+
+All URIs are relative to *https://secure.ultracart.com/rest/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_sso_session_user**](SsoApi.md#get_sso_session_user) | **GET** /sso/session/user | Get single sign on session user
+[**sso_authorize**](SsoApi.md#sso_authorize) | **PUT** /sso/authorize | Authorize a single sign on session
+[**sso_session_revoke**](SsoApi.md#sso_session_revoke) | **DELETE** /sso/session/revoke | Revoke single sign on session
+[**sso_token**](SsoApi.md#sso_token) | **PUT** /sso/token | Exchange a single sign on code for a simple key token
+
+
+# **get_sso_session_user**
+> User get_sso_session_user
+
+Get single sign on session user
+
+This is the equivalent of logging out of the single sign on session 
+
+### 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::SsoApi.new_using_api_key(simple_key, false, false)
+
+
+
+begin
+  #Get single sign on session user
+  result = api_instance.get_sso_session_user
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling SsoApi->get_sso_session_user: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
+# **sso_authorize**
+> ItemsResponse sso_authorize(authorization_request)
+
+Authorize a single sign on session
+
+Starts the process of authorizing a single sign on session. 
+
+### 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::SsoApi.new_using_api_key(simple_key, false, false)
+
+
+authorization_request = UltracartClient::SingleSignOnAuthorizeRequest.new # SingleSignOnAuthorizeRequest | Authorization request
+
+
+begin
+  #Authorize a single sign on session
+  result = api_instance.sso_authorize(authorization_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling SsoApi->sso_authorize: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization_request** | [**SingleSignOnAuthorizeRequest**](SingleSignOnAuthorizeRequest.md)| Authorization request | 
+
+### Return type
+
+[**ItemsResponse**](ItemsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
+# **sso_session_revoke**
+> sso_session_revoke
+
+Revoke single sign on session
+
+This is the equivalent of logging out of the single sign on session 
+
+### 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::SsoApi.new_using_api_key(simple_key, false, false)
+
+
+
+begin
+  #Revoke single sign on session
+  api_instance.sso_session_revoke
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling SsoApi->sso_session_revoke: #{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**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
+# **sso_token**
+> ItemsResponse sso_token(token_request)
+
+Exchange a single sign on code for a simple key token
+
+Called by your application after receiving the code back on the redirect URI to obtain a simple key token to make API calls with 
+
+### 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::SsoApi.new_using_api_key(simple_key, false, false)
+
+
+token_request = UltracartClient::SingleSignOnTokenRequest.new # SingleSignOnTokenRequest | Token request
+
+
+begin
+  #Exchange a single sign on code for a simple key token
+  result = api_instance.sso_token(token_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling SsoApi->sso_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **token_request** | [**SingleSignOnTokenRequest**](SingleSignOnTokenRequest.md)| Token request | 
+
+### Return type
+
+[**ItemsResponse**](ItemsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+

data/docs/StorefrontApi.md

@@ -48,6 +48,7 @@ Method | HTTP request | Description
 [**get_email_customers**](StorefrontApi.md#get_email_customers) | **GET** /storefront/{storefront_oid}/email/customers | Get email customers
 [**get_email_dashboard_activity**](StorefrontApi.md#get_email_dashboard_activity) | **GET** /storefront/{storefront_oid}/email/dashboard_activity | Get email dashboard activity
 [**get_email_dashboard_stats**](StorefrontApi.md#get_email_dashboard_stats) | **GET** /storefront/{storefront_oid}/email/dashboard_stats | Get dashboard stats
+[**get_email_dispatch_logs**](StorefrontApi.md#get_email_dispatch_logs) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/logs | Get email dispatch logs
 [**get_email_email**](StorefrontApi.md#get_email_email) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Get email email
 [**get_email_email_clicks**](StorefrontApi.md#get_email_email_clicks) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/clicks | Get email email clicks
 [**get_email_email_customer_editor_url**](StorefrontApi.md#get_email_email_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/orders/{order_id}/editor_url | Get email order customer editor url
@@ -2395,6 +2396,60 @@ Name | Type | Description  | Notes
 
 
 
+# **get_email_dispatch_logs**
+> EmailCommseqStepLogsResponse get_email_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid)
+
+Get email dispatch logs
+
+### 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::StorefrontApi.new_using_api_key(simple_key, false, false)
+
+
+storefront_oid = 56 # Integer | 
+
+commseq_uuid = 'commseq_uuid_example' # String | 
+
+commseq_step_uuid = 'commseq_step_uuid_example' # String | 
+
+
+begin
+  #Get email dispatch logs
+  result = api_instance.get_email_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->get_email_dispatch_logs: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **storefront_oid** | **Integer**|  | 
+ **commseq_uuid** | **String**|  | 
+ **commseq_step_uuid** | **String**|  | 
+
+### Return type
+
+[**EmailCommseqStepLogsResponse**](EmailCommseqStepLogsResponse.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_email**
 > EmailCommseqEmailResponse get_email_email(storefront_oid, commseq_email_uuid)