ultracart_api 3.2.14 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 626bdb13b840746c2ee4cdeb9c7c433d9e49a5cfbe3a194202becb55bc76f696
-  data.tar.gz: 160e233860d060e9197659a17c3ec2d92626cf8618747c7bfb766cb9df8fe562
+  metadata.gz: 94efd609acdfdc97a1723452a7e90da9fc89b3f86ae5d02b8b48c706e969018c
+  data.tar.gz: 7412f2aa45760fad55ea1ff684488b3054ed0cc4e2a1b5d19e8bea83ebd5bcf8
 SHA512:
-  metadata.gz: 5a50cd08bb0371e6a2c0763d28f31a44c55edf58d9b5782d548f2e2f07d5506b90887a7c5be435d773f87fac79c591382c3bfc0ca0ea82f2de49961116ca7843
-  data.tar.gz: b8c0d6a8bd433328409a64c2ecbba849aa460280efe0a1b67dbe8cdd882bc64bb6cc3dc39fe343da13a5c39355be521f7ee3c7c338342f1d0d236b05dd25d5d4
+  metadata.gz: 87b17f2a5b510b65647546cd87525be3840e6fb6564552c0629b5dfb696be2d89541eb669303d21bb4e55d400ad8ad850abc2190f4b9bce6a4a187f990235d90
+  data.tar.gz: fead47614254b4e61c3bd385a5c7c34553827cceec181ff91ef255b1dc78da3925b95629d3ed6fe7b3dbc440de4e60ee8830e88e23006460db12fe132ae554b5

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.14
+- Package version: 3.3.2
 - 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.14.gem
+gem install ./ultracart_api-3.3.2.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.2.14.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.3.2.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.14'
+    gem 'ultracart_api', '~> 3.3.2'
 
 ### Install from Git
 
@@ -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,10 @@ 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::SingleSignOnAuthorizeResponse](docs/SingleSignOnAuthorizeResponse.md)
+ - [UltracartClient::SingleSignOnTokenRequest](docs/SingleSignOnTokenRequest.md)
+ - [UltracartClient::SingleSignOnTokenResponse](docs/SingleSignOnTokenResponse.md)
  - [UltracartClient::SovosConfig](docs/SovosConfig.md)
  - [UltracartClient::StateProvince](docs/StateProvince.md)
  - [UltracartClient::StepWaiting](docs/StepWaiting.md)
@@ -1035,6 +1046,10 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.3.2 | 07/16/2021 | sso bug fixes | 
+| 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 | 

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

@@ -0,0 +1,9 @@
+# UltracartClient::SingleSignOnAuthorizeResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_dts** | **String** | Expiration date/time after which the single sign-on login operation will have timed out | [optional] 
+**login_url** | **String** | The URL that you should redirect the customer's browser to.  This URL will begin the login process. | [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/SingleSignOnTokenResponse.md

@@ -0,0 +1,10 @@
+# UltracartClient::SingleSignOnTokenResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_dts** | **String** | Expiration date/time after which time the key is no longer valid | [optional] 
+**ip_address** | **String** | IP address of the user which we recommend you lock the simple key's usage to. | [optional] 
+**simple_key** | **String** | The simple key that can then be used to make SDK calls on the users behalf. | [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**
+> SingleSignOnAuthorizeResponse 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
+
+[**SingleSignOnAuthorizeResponse**](SingleSignOnAuthorizeResponse.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**
+> SingleSignOnTokenResponse 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
+
+[**SingleSignOnTokenResponse**](SingleSignOnTokenResponse.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)
 

data/lib/ultracart_api.rb

@@ -235,6 +235,8 @@ require 'ultracart_api/models/email_commseq_response'
 require 'ultracart_api/models/email_commseq_stat'
 require 'ultracart_api/models/email_commseq_stat_response'
 require 'ultracart_api/models/email_commseq_step'
+require 'ultracart_api/models/email_commseq_step_log'
+require 'ultracart_api/models/email_commseq_step_logs_response'
 require 'ultracart_api/models/email_commseqs_response'
 require 'ultracart_api/models/email_customer'
 require 'ultracart_api/models/email_customer_editor_url_response'
@@ -543,6 +545,10 @@ require 'ultracart_api/models/screen_recording_user_property'
 require 'ultracart_api/models/screenshots_response'
 require 'ultracart_api/models/self_config'
 require 'ultracart_api/models/simple_value'
+require 'ultracart_api/models/single_sign_on_authorize_request'
+require 'ultracart_api/models/single_sign_on_authorize_response'
+require 'ultracart_api/models/single_sign_on_token_request'
+require 'ultracart_api/models/single_sign_on_token_response'
 require 'ultracart_api/models/sovos_config'
 require 'ultracart_api/models/state_province'
 require 'ultracart_api/models/step_waiting'
@@ -611,6 +617,7 @@ require 'ultracart_api/api/integration_log_api'
 require 'ultracart_api/api/item_api'
 require 'ultracart_api/api/oauth_api'
 require 'ultracart_api/api/order_api'
+require 'ultracart_api/api/sso_api'
 require 'ultracart_api/api/storefront_api'
 require 'ultracart_api/api/tax_api'
 require 'ultracart_api/api/user_api'