ultracart_api 3.11.17 → 3.11.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 712d427ceb28f13951dfa3516c9ddf5c01cc6e286cfdda0f24d722bd88cb73fb
-  data.tar.gz: 661b1f0275b0e88511cadede357f2b11e7a681c4973f3df2e739548788c06d11
+  metadata.gz: 4b8eff51a39002262cf310b2b17f4bc56c390847951a1e3bda57cc0c0fe5b033
+  data.tar.gz: c7593a062115b62040ab4f4fb4791483a7de229dc8bc59a73487423423b6ca7d
 SHA512:
-  metadata.gz: 627d4a5393e372b9f016a4e1daff5dc529eff80ca01b9d12763ad5aaaa6c32135e375f3bccb19979bc93c769372600efd28336d5290f3613eebd14a7b40a7bd3
-  data.tar.gz: f591bff493dda67c33560b2fa09fbd5c36358518ec4cb05800aad23b22d79c6627886e2af5c68bf7721fb659ee41d7d757b7f8d37b6977ad69b62557cdb44f39
+  metadata.gz: e0b92b0fb98fe3e3f2da01a99e75e98123ff8f7d3533b7ab32f93adea38b38a85b7c2ecc922edce3efbbdf1be6ee1c2d8a5200455b79c270054afb8cacb52e52
+  data.tar.gz: feafaa57c5fedc649a05826516876a46a7284e5af68c273927cdcf31ffe064f591eec92cf3b59d568484e7a2646e486c3beed2078052c7babafb23e17bde400b

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.11.17
+- Package version: 3.11.18
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.11.17.gem
+gem install ./ultracart_api-3.11.18.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.11.17.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.11.18.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.11.17'
+    gem 'ultracart_api', '~> 3.11.18'
 
 ### Install from Git
 
@@ -410,6 +410,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::StorefrontApi* | [**get_email_campaigns**](docs/StorefrontApi.md#get_email_campaigns) | **GET** /storefront/{storefront_oid}/email/campaigns | Get email campaigns
 *UltracartClient::StorefrontApi* | [**get_email_campaigns_with_stats**](docs/StorefrontApi.md#get_email_campaigns_with_stats) | **GET** /storefront/{storefront_oid}/email/campaignsWithStats/{stat_days} | Get email campaigns with stats
 *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_editor_values**](docs/StorefrontApi.md#get_email_commseq_editor_values) | **GET** /storefront/{storefront_oid}/email/commseqs/editorValues | Get email merchant specific editor values
 *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
@@ -1018,6 +1019,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::EmailDashboardStatsResponse](docs/EmailDashboardStatsResponse.md)
  - [UltracartClient::EmailDomain](docs/EmailDomain.md)
  - [UltracartClient::EmailEditorTokenResponse](docs/EmailEditorTokenResponse.md)
+ - [UltracartClient::EmailEditorValuesResponse](docs/EmailEditorValuesResponse.md)
  - [UltracartClient::EmailFlow](docs/EmailFlow.md)
  - [UltracartClient::EmailFlowBackPopulateRequest](docs/EmailFlowBackPopulateRequest.md)
  - [UltracartClient::EmailFlowBackPopulateResponse](docs/EmailFlowBackPopulateResponse.md)
@@ -1567,6 +1569,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
 | 3.11.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
 | 3.11.16 | 07/28/2025 | updated doc samples |
 | 3.11.15 | 07/28/2025 | new order methods for blocking and unblocking refunds |

data/docs/EmailEditorValuesResponse.md

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

data/docs/EmailWebhookEditorValuesResponse.md

@@ -6,7 +6,6 @@ Name | Type | Description | Notes
 **available_expansions** | **Array<String>** |  | [optional] 
 **available_tokens** | **Array<String>** |  | [optional] 
 **error** | [**Error**](Error.md) |  | [optional] 
-**loyalty_tiers** | **Array<String>** |  | [optional] 
 **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
 **rest_object_type** | **String** |  | [optional] 
 **success** | **BOOLEAN** | Indicates if API call was successful | [optional] 

data/docs/StorefrontApi.md

@@ -44,6 +44,7 @@ Method | HTTP request | Description
 [**get_email_campaigns**](StorefrontApi.md#get_email_campaigns) | **GET** /storefront/{storefront_oid}/email/campaigns | Get email campaigns
 [**get_email_campaigns_with_stats**](StorefrontApi.md#get_email_campaigns_with_stats) | **GET** /storefront/{storefront_oid}/email/campaignsWithStats/{stat_days} | Get email campaigns with stats
 [**get_email_commseq**](StorefrontApi.md#get_email_commseq) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} | Get email commseq
+[**get_email_commseq_editor_values**](StorefrontApi.md#get_email_commseq_editor_values) | **GET** /storefront/{storefront_oid}/email/commseqs/editorValues | Get email merchant specific editor values
 [**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
@@ -2203,6 +2204,54 @@ Name | Type | Description  | Notes
 
 
 
+# **get_email_commseq_editor_values**
+> EmailEditorValuesResponse get_email_commseq_editor_values(storefront_oid)
+
+Get email merchant specific editor values
+
+### 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 | 
+
+
+begin
+  #Get email merchant specific editor values
+  result = api_instance.get_email_commseq_editor_values(storefront_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->get_email_commseq_editor_values: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **storefront_oid** | **Integer**|  | 
+
+### Return type
+
+[**EmailEditorValuesResponse**](EmailEditorValuesResponse.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_email_stats**
 > EmailStatSummaryResponse get_email_commseq_email_stats(storefront_oid, commseq_uuid, stats_request)
 

data/lib/ultracart_api/api/storefront_api.rb

@@ -2327,6 +2327,59 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get email merchant specific editor values
+    # @param storefront_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [EmailEditorValuesResponse]
+    def get_email_commseq_editor_values(storefront_oid, opts = {})
+      data, _status_code, _headers = get_email_commseq_editor_values_with_http_info(storefront_oid, opts)
+      data
+    end
+
+    # Get email merchant specific editor values
+    # @param storefront_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailEditorValuesResponse, Fixnum, Hash)>] EmailEditorValuesResponse data, response status code and response headers
+    def get_email_commseq_editor_values_with_http_info(storefront_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_editor_values ...'
+      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_editor_values"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/commseqs/editorValues'.sub('{' + 'storefront_oid' + '}', storefront_oid.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 => 'EmailEditorValuesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_editor_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get email communication sequence emails stats
     # @param storefront_oid 
     # @param commseq_uuid 

data/lib/ultracart_api/models/email_editor_values_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 EmailEditorValuesResponse
+    attr_accessor :error
+
+    attr_accessor :loyalty_tiers
+
+    attr_accessor :metadata
+
+    # 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',
+        :'loyalty_tiers' => :'loyalty_tiers',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error' => :'Error',
+        :'loyalty_tiers' => :'Array<String>',
+        :'metadata' => :'ResponseMetadata',
+        :'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?(:'loyalty_tiers')
+        if (value = attributes[:'loyalty_tiers']).is_a?(Array)
+          self.loyalty_tiers = value
+        end
+      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?(:'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 &&
+          loyalty_tiers == o.loyalty_tiers &&
+          metadata == o.metadata &&
+          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, loyalty_tiers, metadata, 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/models/email_webhook_editor_values_response.rb

@@ -20,8 +20,6 @@ module UltracartClient
 
     attr_accessor :error
 
-    attr_accessor :loyalty_tiers
-
     attr_accessor :metadata
 
     attr_accessor :rest_object_type
@@ -37,7 +35,6 @@ module UltracartClient
         :'available_expansions' => :'available_expansions',
         :'available_tokens' => :'available_tokens',
         :'error' => :'error',
-        :'loyalty_tiers' => :'loyalty_tiers',
         :'metadata' => :'metadata',
         :'rest_object_type' => :'rest_object_type',
         :'success' => :'success',
@@ -51,7 +48,6 @@ module UltracartClient
         :'available_expansions' => :'Array<String>',
         :'available_tokens' => :'Array<String>',
         :'error' => :'Error',
-        :'loyalty_tiers' => :'Array<String>',
         :'metadata' => :'ResponseMetadata',
         :'rest_object_type' => :'String',
         :'success' => :'BOOLEAN',
@@ -83,12 +79,6 @@ module UltracartClient
         self.error = attributes[:'error']
       end
 
-      if attributes.has_key?(:'loyalty_tiers')
-        if (value = attributes[:'loyalty_tiers']).is_a?(Array)
-          self.loyalty_tiers = value
-        end
-      end
-
       if attributes.has_key?(:'metadata')
         self.metadata = attributes[:'metadata']
       end
@@ -127,7 +117,6 @@ module UltracartClient
           available_expansions == o.available_expansions &&
           available_tokens == o.available_tokens &&
           error == o.error &&
-          loyalty_tiers == o.loyalty_tiers &&
           metadata == o.metadata &&
           rest_object_type == o.rest_object_type &&
           success == o.success &&
@@ -143,7 +132,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [available_expansions, available_tokens, error, loyalty_tiers, metadata, rest_object_type, success, warning].hash
+      [available_expansions, available_tokens, error, metadata, rest_object_type, success, warning].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

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

data/lib/ultracart_api.rb

@@ -424,6 +424,7 @@ require 'ultracart_api/models/email_dashboard_activity_response'
 require 'ultracart_api/models/email_dashboard_stats_response'
 require 'ultracart_api/models/email_domain'
 require 'ultracart_api/models/email_editor_token_response'
+require 'ultracart_api/models/email_editor_values_response'
 require 'ultracart_api/models/email_flow'
 require 'ultracart_api/models/email_flow_back_populate_request'
 require 'ultracart_api/models/email_flow_back_populate_response'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.11.17
+  version: 3.11.18
 platform: ruby
 authors:
 - UltraCart
@@ -637,6 +637,7 @@ files:
 - docs/EmailDashboardStatsResponse.md
 - docs/EmailDomain.md
 - docs/EmailEditorTokenResponse.md
+- docs/EmailEditorValuesResponse.md
 - docs/EmailFlow.md
 - docs/EmailFlowBackPopulateRequest.md
 - docs/EmailFlowBackPopulateResponse.md
@@ -1559,6 +1560,7 @@ files:
 - lib/ultracart_api/models/email_dashboard_stats_response.rb
 - lib/ultracart_api/models/email_domain.rb
 - lib/ultracart_api/models/email_editor_token_response.rb
+- lib/ultracart_api/models/email_editor_values_response.rb
 - lib/ultracart_api/models/email_flow.rb
 - lib/ultracart_api/models/email_flow_back_populate_request.rb
 - lib/ultracart_api/models/email_flow_back_populate_response.rb