ultracart_api 3.10.37 → 3.10.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80ef1808819f662db57e52efb4ac83f460d39f72aeea9092c68093b880e86f2d
-  data.tar.gz: 3bfaedc49043449925965f8b0d81c34e02f0e62785fe19d52a19ea066ce47fb7
+  metadata.gz: c9e126c9883f349713b1fd0f02b4d5567039b6d2f0f97fc4f851d41efb67fee9
+  data.tar.gz: 37ef0d0c9841e8370a221d8fced1ff3be1a3aac83c2c96a3851f46bf9d322dc2
 SHA512:
-  metadata.gz: 27bcd34296d1dc032506c3f0aa01c8f074416b9cdb03ec7a2cc27c8914286a1ddb406ce02c762538afcad5cf32b5f8518c33d0a80ed214da8b8fcd61db0a16ac
-  data.tar.gz: 3c9c722d3c8393ff6da6a3abc40be1b7ef4a2963c4be6f61ebb5c88e573d542202b39433ba1e57ac4b633fd7f68dfd5d1d18f79057fb73cf7b6b94bafefd9abc
+  metadata.gz: f03922d07db66d388c2ab34e5957fa67e793163e84f3795ce4fa97d29ce5a987322911cf0b8e2b4333d66d8f75db3da1188896aa853a5a963995cf965d5be504
+  data.tar.gz: 984c0a4995aeb37f338fd6593d404454522a657ff4db1838d15b7f13bfbb997bc6520e60b119d124455bb1b95c60936f1133239f72a0133662ea4f8c4e95ff1c

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.37
+- Package version: 3.10.38
 - 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.37.gem
+gem install ./ultracart_api-3.10.38.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.37.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.38.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.37'
+    gem 'ultracart_api', '~> 3.10.38'
 
 ### Install from Git
 
@@ -165,6 +165,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::CustomerApi* | [**get_customers_by_query**](docs/CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
 *UltracartClient::CustomerApi* | [**get_customers_for_data_tables**](docs/CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
 *UltracartClient::CustomerApi* | [**get_email_verification_token**](docs/CustomerApi.md#get_email_verification_token) | **POST** /customer/customers/email_verify/get_token | Create a token that can be used to verify a customer email address
+*UltracartClient::CustomerApi* | [**get_magic_link**](docs/CustomerApi.md#get_magic_link) | **PUT** /customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name} | getMagicLink
 *UltracartClient::CustomerApi* | [**insert_customer**](docs/CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
 *UltracartClient::CustomerApi* | [**merge_customer**](docs/CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
 *UltracartClient::CustomerApi* | [**search_customer_profile_values**](docs/CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
@@ -329,6 +330,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**get_screen_recordings_by_query**](docs/StorefrontApi.md#get_screen_recordings_by_query) | **POST** /storefront/{storefront_oid}/screen_recordings/query | Query screen recordings
 *UltracartClient::StorefrontApi* | [**get_screen_recordings_by_segment**](docs/StorefrontApi.md#get_screen_recordings_by_segment) | **POST** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}/query | Get screen recordings by segment
 *UltracartClient::StorefrontApi* | [**get_store_front_pricing_tiers**](docs/StorefrontApi.md#get_store_front_pricing_tiers) | **GET** /storefront/pricing_tiers | Retrieve pricing tiers
+*UltracartClient::StorefrontApi* | [**get_store_fronts**](docs/StorefrontApi.md#get_store_fronts) | **GET** /storefront/ | Get storefronts (internal use only for security reasons)
 *UltracartClient::StorefrontApi* | [**get_thumbnail_parameters**](docs/StorefrontApi.md#get_thumbnail_parameters) | **POST** /storefront/thumbnailParameters | Get thumbnail parameters
 *UltracartClient::StorefrontApi* | [**get_transaction_email**](docs/StorefrontApi.md#get_transaction_email) | **GET** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Gets a transaction email object
 *UltracartClient::StorefrontApi* | [**get_transaction_email_list**](docs/StorefrontApi.md#get_transaction_email_list) | **GET** /storefront/{storefront_oid}/transaction_email/list | Gets a list of transaction email names
@@ -661,6 +663,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CustomerLoyalty](docs/CustomerLoyalty.md)
  - [UltracartClient::CustomerLoyaltyLedger](docs/CustomerLoyaltyLedger.md)
  - [UltracartClient::CustomerLoyaltyRedemption](docs/CustomerLoyaltyRedemption.md)
+ - [UltracartClient::CustomerMagicLinkResponse](docs/CustomerMagicLinkResponse.md)
  - [UltracartClient::CustomerMergeRequest](docs/CustomerMergeRequest.md)
  - [UltracartClient::CustomerOrdersSummary](docs/CustomerOrdersSummary.md)
  - [UltracartClient::CustomerPricingTier](docs/CustomerPricingTier.md)
@@ -1048,6 +1051,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::SovosConfig](docs/SovosConfig.md)
  - [UltracartClient::StateProvince](docs/StateProvince.md)
  - [UltracartClient::StepWaiting](docs/StepWaiting.md)
+ - [UltracartClient::StoreFront](docs/StoreFront.md)
+ - [UltracartClient::StoreFrontsResponse](docs/StoreFrontsResponse.md)
  - [UltracartClient::TaxCity](docs/TaxCity.md)
  - [UltracartClient::TaxCountry](docs/TaxCountry.md)
  - [UltracartClient::TaxCountryCode](docs/TaxCountryCode.md)
@@ -1173,6 +1178,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.38 | 08/12/2022 | internal code to allow merchant login as customer |
 | 3.10.37 | 08/11/2022 | fix entry_dts type on gift certificate ledger |
 | 3.10.36 | 08/10/2022 | conversation event refactoring |
 | 3.10.35 | 08/05/2022 | conversation adjustments for ES integration |

data/docs/CustomerApi.md

@@ -16,6 +16,7 @@ Method | HTTP request | Description
 [**get_customers_by_query**](CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
 [**get_customers_for_data_tables**](CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
 [**get_email_verification_token**](CustomerApi.md#get_email_verification_token) | **POST** /customer/customers/email_verify/get_token | Create a token that can be used to verify a customer email address
+[**get_magic_link**](CustomerApi.md#get_magic_link) | **PUT** /customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name} | getMagicLink
 [**insert_customer**](CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
 [**merge_customer**](CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
 [**search_customer_profile_values**](CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
@@ -703,6 +704,59 @@ Name | Type | Description  | Notes
 
 
 
+# **get_magic_link**
+> CustomerMagicLinkResponse get_magic_link(customer_profile_oid, storefront_host_name)
+
+getMagicLink
+
+Retrieves a magic link to allow a merchant to login as a customer.  This method is a PUT call intentionally. 
+
+### 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::CustomerApi.new_using_api_key(simple_key, false, false)
+
+
+customer_profile_oid = 56 # Integer | The customer_profile_oid of the customer.
+
+storefront_host_name = 'storefront_host_name_example' # String | The storefront to log into.
+
+
+begin
+  #getMagicLink
+  result = api_instance.get_magic_link(customer_profile_oid, storefront_host_name)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling CustomerApi->get_magic_link: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer_profile_oid** | **Integer**| The customer_profile_oid of the customer. | 
+ **storefront_host_name** | **String**| The storefront to log into. | 
+
+### Return type
+
+[**CustomerMagicLinkResponse**](CustomerMagicLinkResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **insert_customer**
 > CustomerResponse insert_customer(customer, opts)
 

data/docs/CustomerMagicLinkResponse.md

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

data/docs/StoreFront.md

@@ -0,0 +1,18 @@
+# UltracartClient::StoreFront
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**host_alias1** | **String** |  | [optional] 
+**host_alias2** | **String** |  | [optional] 
+**host_alias3** | **String** |  | [optional] 
+**host_alias4** | **String** |  | [optional] 
+**host_alias5** | **String** |  | [optional] 
+**host_name** | **String** |  | [optional] 
+**locked** | **BOOLEAN** |  | [optional] 
+**merchant_id** | **String** |  | [optional] 
+**redirect_aliases** | **BOOLEAN** |  | [optional] 
+**storefront_oid** | **Integer** |  | [optional] 
+**unlock_password** | **String** |  | [optional] 
+
+

data/docs/StoreFrontsResponse.md

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

data/docs/StorefrontApi.md

@@ -105,6 +105,7 @@ Method | HTTP request | Description
 [**get_screen_recordings_by_query**](StorefrontApi.md#get_screen_recordings_by_query) | **POST** /storefront/{storefront_oid}/screen_recordings/query | Query screen recordings
 [**get_screen_recordings_by_segment**](StorefrontApi.md#get_screen_recordings_by_segment) | **POST** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}/query | Get screen recordings by segment
 [**get_store_front_pricing_tiers**](StorefrontApi.md#get_store_front_pricing_tiers) | **GET** /storefront/pricing_tiers | Retrieve pricing tiers
+[**get_store_fronts**](StorefrontApi.md#get_store_fronts) | **GET** /storefront/ | Get storefronts (internal use only for security reasons)
 [**get_thumbnail_parameters**](StorefrontApi.md#get_thumbnail_parameters) | **POST** /storefront/thumbnailParameters | Get thumbnail parameters
 [**get_transaction_email**](StorefrontApi.md#get_transaction_email) | **GET** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Gets a transaction email object
 [**get_transaction_email_list**](StorefrontApi.md#get_transaction_email_list) | **GET** /storefront/{storefront_oid}/transaction_email/list | Gets a list of transaction email names
@@ -5324,6 +5325,49 @@ Name | Type | Description  | Notes
 
 
 
+# **get_store_fronts**
+> StoreFrontsResponse get_store_fronts
+
+Get storefronts (internal use only for security reasons)
+
+### 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)
+
+
+
+begin
+  #Get storefronts (internal use only for security reasons)
+  result = api_instance.get_store_fronts
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->get_store_fronts: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**StoreFrontsResponse**](StoreFrontsResponse.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_thumbnail_parameters**
 > ThumbnailParametersResponse get_thumbnail_parameters(thumbnail_parameters)
 

data/lib/ultracart_api/api/customer_api.rb

@@ -799,6 +799,67 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # getMagicLink
+    # Retrieves a magic link to allow a merchant to login as a customer.  This method is a PUT call intentionally. 
+    # @param customer_profile_oid The customer_profile_oid of the customer.
+    # @param storefront_host_name The storefront to log into.
+    # @param [Hash] opts the optional parameters
+    # @return [CustomerMagicLinkResponse]
+    def get_magic_link(customer_profile_oid, storefront_host_name, opts = {})
+      data, _status_code, _headers = get_magic_link_with_http_info(customer_profile_oid, storefront_host_name, opts)
+      data
+    end
+
+    # getMagicLink
+    # Retrieves a magic link to allow a merchant to login as a customer.  This method is a PUT call intentionally. 
+    # @param customer_profile_oid The customer_profile_oid of the customer.
+    # @param storefront_host_name The storefront to log into.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomerMagicLinkResponse, Fixnum, Hash)>] CustomerMagicLinkResponse data, response status code and response headers
+    def get_magic_link_with_http_info(customer_profile_oid, storefront_host_name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomerApi.get_magic_link ...'
+      end
+      # verify the required parameter 'customer_profile_oid' is set
+      if @api_client.config.client_side_validation && customer_profile_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.get_magic_link"
+      end
+      # verify the required parameter 'storefront_host_name' is set
+      if @api_client.config.client_side_validation && storefront_host_name.nil?
+        fail ArgumentError, "Missing the required parameter 'storefront_host_name' when calling CustomerApi.get_magic_link"
+      end
+      # resource path
+      local_var_path = '/customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name}'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s).sub('{' + 'storefront_host_name' + '}', storefront_host_name.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; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomerMagicLinkResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomerApi#get_magic_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Insert a customer
     # Insert a customer on the UltraCart account. 
     # @param customer Customer to insert

data/lib/ultracart_api/api/storefront_api.rb

@@ -5898,6 +5898,53 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get storefronts (internal use only for security reasons)
+    # @param [Hash] opts the optional parameters
+    # @return [StoreFrontsResponse]
+    def get_store_fronts(opts = {})
+      data, _status_code, _headers = get_store_fronts_with_http_info(opts)
+      data
+    end
+
+    # Get storefronts (internal use only for security reasons)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(StoreFrontsResponse, Fixnum, Hash)>] StoreFrontsResponse data, response status code and response headers
+    def get_store_fronts_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_store_fronts ...'
+      end
+      # resource path
+      local_var_path = '/storefront/'
+
+      # 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 => 'StoreFrontsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_store_fronts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get thumbnail parameters
     # @param thumbnail_parameters Thumbnail Parameters
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/customer_magic_link_response.rb

@@ -0,0 +1,222 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class CustomerMagicLinkResponse
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    # URL
+    attr_accessor :url
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'url' => :'url',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'BOOLEAN',
+        :'url' => :'String',
+        :'warning' => :'Warning'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.has_key?(:'warning')
+        self.warning = attributes[:'warning']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          error == o.error &&
+          metadata == o.metadata &&
+          success == o.success &&
+          url == o.url &&
+          warning == o.warning
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [error, metadata, success, url, warning].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/models/store_front.rb

@@ -0,0 +1,274 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class StoreFront
+    attr_accessor :host_alias1
+
+    attr_accessor :host_alias2
+
+    attr_accessor :host_alias3
+
+    attr_accessor :host_alias4
+
+    attr_accessor :host_alias5
+
+    attr_accessor :host_name
+
+    attr_accessor :locked
+
+    attr_accessor :merchant_id
+
+    attr_accessor :redirect_aliases
+
+    attr_accessor :storefront_oid
+
+    attr_accessor :unlock_password
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'host_alias1' => :'host_alias1',
+        :'host_alias2' => :'host_alias2',
+        :'host_alias3' => :'host_alias3',
+        :'host_alias4' => :'host_alias4',
+        :'host_alias5' => :'host_alias5',
+        :'host_name' => :'host_name',
+        :'locked' => :'locked',
+        :'merchant_id' => :'merchant_id',
+        :'redirect_aliases' => :'redirect_aliases',
+        :'storefront_oid' => :'storefront_oid',
+        :'unlock_password' => :'unlock_password'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'host_alias1' => :'String',
+        :'host_alias2' => :'String',
+        :'host_alias3' => :'String',
+        :'host_alias4' => :'String',
+        :'host_alias5' => :'String',
+        :'host_name' => :'String',
+        :'locked' => :'BOOLEAN',
+        :'merchant_id' => :'String',
+        :'redirect_aliases' => :'BOOLEAN',
+        :'storefront_oid' => :'Integer',
+        :'unlock_password' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'host_alias1')
+        self.host_alias1 = attributes[:'host_alias1']
+      end
+
+      if attributes.has_key?(:'host_alias2')
+        self.host_alias2 = attributes[:'host_alias2']
+      end
+
+      if attributes.has_key?(:'host_alias3')
+        self.host_alias3 = attributes[:'host_alias3']
+      end
+
+      if attributes.has_key?(:'host_alias4')
+        self.host_alias4 = attributes[:'host_alias4']
+      end
+
+      if attributes.has_key?(:'host_alias5')
+        self.host_alias5 = attributes[:'host_alias5']
+      end
+
+      if attributes.has_key?(:'host_name')
+        self.host_name = attributes[:'host_name']
+      end
+
+      if attributes.has_key?(:'locked')
+        self.locked = attributes[:'locked']
+      end
+
+      if attributes.has_key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.has_key?(:'redirect_aliases')
+        self.redirect_aliases = attributes[:'redirect_aliases']
+      end
+
+      if attributes.has_key?(:'storefront_oid')
+        self.storefront_oid = attributes[:'storefront_oid']
+      end
+
+      if attributes.has_key?(:'unlock_password')
+        self.unlock_password = attributes[:'unlock_password']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          host_alias1 == o.host_alias1 &&
+          host_alias2 == o.host_alias2 &&
+          host_alias3 == o.host_alias3 &&
+          host_alias4 == o.host_alias4 &&
+          host_alias5 == o.host_alias5 &&
+          host_name == o.host_name &&
+          locked == o.locked &&
+          merchant_id == o.merchant_id &&
+          redirect_aliases == o.redirect_aliases &&
+          storefront_oid == o.storefront_oid &&
+          unlock_password == o.unlock_password
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [host_alias1, host_alias2, host_alias3, host_alias4, host_alias5, host_name, locked, merchant_id, redirect_aliases, storefront_oid, unlock_password].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/models/store_fronts_response.rb

@@ -0,0 +1,223 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class StoreFrontsResponse
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    attr_accessor :store_fronts
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'store_fronts' => :'storeFronts',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'store_fronts' => :'Array<StoreFront>',
+        :'success' => :'BOOLEAN',
+        :'warning' => :'Warning'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'storeFronts')
+        if (value = attributes[:'storeFronts']).is_a?(Array)
+          self.store_fronts = value
+        end
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_key?(:'warning')
+        self.warning = attributes[:'warning']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          error == o.error &&
+          metadata == o.metadata &&
+          store_fronts == o.store_fronts &&
+          success == o.success &&
+          warning == o.warning
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [error, metadata, store_fronts, success, warning].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.10.37'
+  VERSION = '3.10.38'
 end

data/lib/ultracart_api.rb

@@ -236,6 +236,7 @@ require 'ultracart_api/models/customer_email_list_changes'
 require 'ultracart_api/models/customer_loyalty'
 require 'ultracart_api/models/customer_loyalty_ledger'
 require 'ultracart_api/models/customer_loyalty_redemption'
+require 'ultracart_api/models/customer_magic_link_response'
 require 'ultracart_api/models/customer_merge_request'
 require 'ultracart_api/models/customer_orders_summary'
 require 'ultracart_api/models/customer_pricing_tier'
@@ -623,6 +624,8 @@ 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'
+require 'ultracart_api/models/store_front'
+require 'ultracart_api/models/store_fronts_response'
 require 'ultracart_api/models/tax_city'
 require 'ultracart_api/models/tax_country'
 require 'ultracart_api/models/tax_country_code'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.37
+  version: 3.10.38
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2022-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -448,6 +448,7 @@ files:
 - docs/CustomerLoyalty.md
 - docs/CustomerLoyaltyLedger.md
 - docs/CustomerLoyaltyRedemption.md
+- docs/CustomerMagicLinkResponse.md
 - docs/CustomerMergeRequest.md
 - docs/CustomerOrdersSummary.md
 - docs/CustomerPricingTier.md
@@ -842,6 +843,8 @@ files:
 - docs/SsoApi.md
 - docs/StateProvince.md
 - docs/StepWaiting.md
+- docs/StoreFront.md
+- docs/StoreFrontsResponse.md
 - docs/StorefrontApi.md
 - docs/TaxApi.md
 - docs/TaxCity.md
@@ -1144,6 +1147,7 @@ files:
 - lib/ultracart_api/models/customer_loyalty.rb
 - lib/ultracart_api/models/customer_loyalty_ledger.rb
 - lib/ultracart_api/models/customer_loyalty_redemption.rb
+- lib/ultracart_api/models/customer_magic_link_response.rb
 - lib/ultracart_api/models/customer_merge_request.rb
 - lib/ultracart_api/models/customer_orders_summary.rb
 - lib/ultracart_api/models/customer_pricing_tier.rb
@@ -1531,6 +1535,8 @@ files:
 - lib/ultracart_api/models/sovos_config.rb
 - lib/ultracart_api/models/state_province.rb
 - lib/ultracart_api/models/step_waiting.rb
+- lib/ultracart_api/models/store_front.rb
+- lib/ultracart_api/models/store_fronts_response.rb
 - lib/ultracart_api/models/tax_city.rb
 - lib/ultracart_api/models/tax_country.rb
 - lib/ultracart_api/models/tax_country_code.rb