ultracart_api 3.10.43 → 3.10.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 943409e2cf0d7ab590a3e2285bf09eca4c40b1e61ade3859197cd25a8b265779
-  data.tar.gz: 519dbd467596da5075ba1a37531db604a9284e8bfde6c297cfbaf849367833f6
+  metadata.gz: 377b9d095f723be07c9afffb03549128473ca5d53d2db8166589f5b1927f3c7a
+  data.tar.gz: c9798b40411f46e8a96ddfc213582bee2f6b5147c24c66a42ad842b4171149e8
 SHA512:
-  metadata.gz: b53298f0c4083caf61214afb77d06640ca48f50445aa0d1cdb72da3b7f601694e3ac5eb34f02241f9064b5b1599f9ee58a214f0a3e1fd258951818a907d388aa
-  data.tar.gz: c8c221b8a619cf88772f0d03a12955cbf94e1314e7160d09e0225dfbdf5076de210ed55fb2cff8d9bcec286aa9a73a7ccc36f28a0a3f8a12201589961061cc45
+  metadata.gz: 87e752a22dc48d8d6f2803e37717c0ec756044c467beb0fa8de4edade1573074718fc3acede9530c5a866ece6af81628bc925626720f491163087e877c0192f2
+  data.tar.gz: dfeb897c6054f77b3f11b35e09dcec872b72955056a4f823f14cb60e964da372c099b0bdb2d0edf37543aa737866bee268e824195873e462cb3914272f597d21

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.10.43
+- Package version: 3.10.46
 - 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.10.43.gem
+gem install ./ultracart_api-3.10.46.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.43.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.46.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.10.43'
+    gem 'ultracart_api', '~> 3.10.46'
 
 ### Install from Git
 
@@ -269,6 +269,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**get_email_commseq**](docs/StorefrontApi.md#get_email_commseq) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} | Get email commseq
 *UltracartClient::StorefrontApi* | [**get_email_commseq_email_stats**](docs/StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats
 *UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_stats**](docs/StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats
+*UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_tracking**](docs/StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking
 *UltracartClient::StorefrontApi* | [**get_email_commseq_stat_overall**](docs/StorefrontApi.md#get_email_commseq_stat_overall) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Get communication sequence stats overall
 *UltracartClient::StorefrontApi* | [**get_email_commseq_step_stats**](docs/StorefrontApi.md#get_email_commseq_step_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats | Get email communication sequence step stats
 *UltracartClient::StorefrontApi* | [**get_email_commseq_step_waiting**](docs/StorefrontApi.md#get_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting | Get email communication sequence customers waiting at each requested step
@@ -393,6 +394,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**update_screen_recording_tags**](docs/StorefrontApi.md#update_screen_recording_tags) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags | Update tags on a screen recording
 *UltracartClient::StorefrontApi* | [**update_transaction_email**](docs/StorefrontApi.md#update_transaction_email) | **PUT** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Updates a transaction email object
 *UltracartClient::StorefrontApi* | [**update_twilio_account**](docs/StorefrontApi.md#update_twilio_account) | **PUT** /storefront/twilio/accounts/{esp_twilio_uuid} | Update Twilio account
+*UltracartClient::StorefrontApi* | [**validate_ruler**](docs/StorefrontApi.md#validate_ruler) | **POST** /storefront/ruler/validate | Validate AWS Event Ruler
 *UltracartClient::TaxApi* | [**delete_tax_provider_self_city**](docs/TaxApi.md#delete_tax_provider_self_city) | **DELETE** /tax/providers/self/city/{city} | Deletes a Self tax provider city
 *UltracartClient::TaxApi* | [**delete_tax_provider_self_country**](docs/TaxApi.md#delete_tax_provider_self_country) | **DELETE** /tax/providers/self/country/{countryCode} | Deletes a Self tax provider country
 *UltracartClient::TaxApi* | [**delete_tax_provider_self_county**](docs/TaxApi.md#delete_tax_provider_self_county) | **DELETE** /tax/providers/self/county/{county} | Deletes a Self tax provider county
@@ -763,6 +765,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::EmailPlanAdditional](docs/EmailPlanAdditional.md)
  - [UltracartClient::EmailPlanResponse](docs/EmailPlanResponse.md)
  - [UltracartClient::EmailPostcardStat](docs/EmailPostcardStat.md)
+ - [UltracartClient::EmailPostcardTracking](docs/EmailPostcardTracking.md)
+ - [UltracartClient::EmailPostcardTrackingResponse](docs/EmailPostcardTrackingResponse.md)
  - [UltracartClient::EmailSegment](docs/EmailSegment.md)
  - [UltracartClient::EmailSegmentArchiveResponse](docs/EmailSegmentArchiveResponse.md)
  - [UltracartClient::EmailSegmentCustomer](docs/EmailSegmentCustomer.md)
@@ -994,6 +998,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::RegisterAffiliateClickResponse](docs/RegisterAffiliateClickResponse.md)
  - [UltracartClient::ResponseMetadata](docs/ResponseMetadata.md)
  - [UltracartClient::ResultSet](docs/ResultSet.md)
+ - [UltracartClient::RulerValidationRequest](docs/RulerValidationRequest.md)
+ - [UltracartClient::RulerValidationResponse](docs/RulerValidationResponse.md)
  - [UltracartClient::ScreenRecording](docs/ScreenRecording.md)
  - [UltracartClient::ScreenRecordingAdPlatform](docs/ScreenRecordingAdPlatform.md)
  - [UltracartClient::ScreenRecordingFilter](docs/ScreenRecordingFilter.md)
@@ -1179,6 +1185,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.46 | 09/13/2022 | storefront comms - postcard tracking |
+| 3.10.45 | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
+| 3.10.44 | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |
 | 3.10.43 | 09/02/2022 | customer editor added loyal ledger descriptions |
 | 3.10.42 | 08/30/2022 | storefront comm fields for sms configuration |
 | 3.10.41 | 08/26/2022 | postcard address fields for comm sequence testing |

data/docs/EmailPostcardTracking.md

@@ -0,0 +1,32 @@
+# UltracartClient::EmailPostcardTracking
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**commseq_postcard_uuid** | **String** |  | [optional] 
+**commseq_step_uuid** | **String** |  | [optional] 
+**commseq_uuid** | **String** |  | [optional] 
+**conversion_dts** | **String** | Conversion date time. | [optional] 
+**cost** | **Float** |  | [optional] 
+**customer_uuid** | **String** |  | [optional] 
+**delivered_dts** | **String** | Delivered date time. | [optional] 
+**from_address_line1** | **String** |  | [optional] 
+**from_address_line2** | **String** |  | [optional] 
+**from_city** | **String** |  | [optional] 
+**from_name** | **String** |  | [optional] 
+**from_state** | **String** |  | [optional] 
+**from_zip** | **String** |  | [optional] 
+**mailed_dts** | **String** | Mailed date time. | [optional] 
+**order_id** | **String** |  | [optional] 
+**postcard_tracking_uuid** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**submit_dts** | **String** | Submit date time. | [optional] 
+**to_address_line1** | **String** |  | [optional] 
+**to_address_line2** | **String** |  | [optional] 
+**to_city** | **String** |  | [optional] 
+**to_name** | **String** |  | [optional] 
+**to_state** | **String** |  | [optional] 
+**to_zip** | **String** |  | [optional] 
+**tracking_description** | **String** |  | [optional] 
+
+

data/docs/EmailPostcardTrackingResponse.md

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

data/docs/EmailSettings.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **postcard_from_name** | **String** |  | [optional] 
 **postcard_from_postal_code** | **String** |  | [optional] 
 **postcard_from_state** | **String** |  | [optional] 
+**reviews_io_configured** | **BOOLEAN** | True if the Reviews.io integration is configured | [optional] 
 **sms_esp_twilio_uuid** | **String** |  | [optional] 
 **sms_phone_number** | **String** |  | [optional] 
 **transactional_esp_domain_user** | **String** |  | [optional] 

data/docs/RulerValidationRequest.md

@@ -0,0 +1,8 @@
+# UltracartClient::RulerValidationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ruler** | **String** |  | [optional] 
+
+

data/docs/RulerValidationResponse.md

@@ -0,0 +1,9 @@
+# UltracartClient::RulerValidationResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_message** | **String** |  | [optional] 
+**valid** | **BOOLEAN** |  | [optional] 
+
+

data/docs/StorefrontApi.md

@@ -44,6 +44,7 @@ Method | HTTP request | Description
 [**get_email_commseq**](StorefrontApi.md#get_email_commseq) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} | Get email commseq
 [**get_email_commseq_email_stats**](StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats
 [**get_email_commseq_postcard_stats**](StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats
+[**get_email_commseq_postcard_tracking**](StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking
 [**get_email_commseq_stat_overall**](StorefrontApi.md#get_email_commseq_stat_overall) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Get communication sequence stats overall
 [**get_email_commseq_step_stats**](StorefrontApi.md#get_email_commseq_step_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats | Get email communication sequence step stats
 [**get_email_commseq_step_waiting**](StorefrontApi.md#get_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting | Get email communication sequence customers waiting at each requested step
@@ -168,6 +169,7 @@ Method | HTTP request | Description
 [**update_screen_recording_tags**](StorefrontApi.md#update_screen_recording_tags) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags | Update tags on a screen recording
 [**update_transaction_email**](StorefrontApi.md#update_transaction_email) | **PUT** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Updates a transaction email object
 [**update_twilio_account**](StorefrontApi.md#update_twilio_account) | **PUT** /storefront/twilio/accounts/{esp_twilio_uuid} | Update Twilio account
+[**validate_ruler**](StorefrontApi.md#validate_ruler) | **POST** /storefront/ruler/validate | Validate AWS Event Ruler
 
 
 # **add_to_library**
@@ -2189,6 +2191,57 @@ Name | Type | Description  | Notes
 
 
 
+# **get_email_commseq_postcard_tracking**
+> EmailPostcardTrackingResponse get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid)
+
+Get email communication postcard tracking
+
+### 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_postcard_uuid = 'commseq_postcard_uuid_example' # String | 
+
+
+begin
+  #Get email communication postcard tracking
+  result = api_instance.get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->get_email_commseq_postcard_tracking: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **storefront_oid** | **Integer**|  | 
+ **commseq_postcard_uuid** | **String**|  | 
+
+### Return type
+
+[**EmailPostcardTrackingResponse**](EmailPostcardTrackingResponse.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_commseq_stat_overall**
 > EmailCommseqStatResponse get_email_commseq_stat_overall(storefront_oid, commseq_uuid)
 
@@ -8622,3 +8675,51 @@ Name | Type | Description  | Notes
 
 
 
+# **validate_ruler**
+> RulerValidationResponse validate_ruler(ruler_validate_request)
+
+Validate AWS Event Ruler
+
+### 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)
+
+
+ruler_validate_request = UltracartClient::RulerValidationRequest.new # RulerValidationRequest | Ruler Validate Request
+
+
+begin
+  #Validate AWS Event Ruler
+  result = api_instance.validate_ruler(ruler_validate_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->validate_ruler: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ruler_validate_request** | [**RulerValidationRequest**](RulerValidationRequest.md)| Ruler Validate Request | 
+
+### Return type
+
+[**RulerValidationResponse**](RulerValidationResponse.md)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/lib/ultracart_api/api/storefront_api.rb

@@ -2339,6 +2339,65 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get email communication postcard tracking
+    # @param storefront_oid 
+    # @param commseq_postcard_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [EmailPostcardTrackingResponse]
+    def get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid, opts = {})
+      data, _status_code, _headers = get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid, opts)
+      data
+    end
+
+    # Get email communication postcard tracking
+    # @param storefront_oid 
+    # @param commseq_postcard_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailPostcardTrackingResponse, Fixnum, Hash)>] EmailPostcardTrackingResponse data, response status code and response headers
+    def get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_postcard_tracking ...'
+      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_commseq_postcard_tracking"
+      end
+      # verify the required parameter 'commseq_postcard_uuid' is set
+      if @api_client.config.client_side_validation && commseq_postcard_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'commseq_postcard_uuid' when calling StorefrontApi.get_email_commseq_postcard_tracking"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s).sub('{' + 'commseq_postcard_uuid' + '}', commseq_postcard_uuid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'EmailPostcardTrackingResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_postcard_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get communication sequence stats overall
     # @param storefront_oid 
     # @param commseq_uuid 
@@ -9725,5 +9784,58 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Validate AWS Event Ruler
+    # @param ruler_validate_request Ruler Validate Request
+    # @param [Hash] opts the optional parameters
+    # @return [RulerValidationResponse]
+    def validate_ruler(ruler_validate_request, opts = {})
+      data, _status_code, _headers = validate_ruler_with_http_info(ruler_validate_request, opts)
+      data
+    end
+
+    # Validate AWS Event Ruler
+    # @param ruler_validate_request Ruler Validate Request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RulerValidationResponse, Fixnum, Hash)>] RulerValidationResponse data, response status code and response headers
+    def validate_ruler_with_http_info(ruler_validate_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.validate_ruler ...'
+      end
+      # verify the required parameter 'ruler_validate_request' is set
+      if @api_client.config.client_side_validation && ruler_validate_request.nil?
+        fail ArgumentError, "Missing the required parameter 'ruler_validate_request' when calling StorefrontApi.validate_ruler"
+      end
+      # resource path
+      local_var_path = '/storefront/ruler/validate'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(ruler_validate_request)
+      auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'RulerValidationResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#validate_ruler\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end