ultracart_api 3.4.11 → 3.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4245e873129516de30be38429ec9b9be35c51980741b172ae00e772d36ff69f3
-  data.tar.gz: e58e9e32bca389b1cadafff9e4089df77aaba05766aa65e9e185156f96fcfe1e
+  metadata.gz: f7063e9772931a88f569176858a4e4dcfdedaa6774dfcc6070c01f4ad0ee67e4
+  data.tar.gz: e214680964f066ca4c030047eb71abf8a4949dcf96954bf91b51afb304e29b20
 SHA512:
-  metadata.gz: baa5e4e73a5922c38c3ade92ff47d0ea9268a5bbb6ca2a6b108248fc9c71011552184f3de33b17a6f8314c6930224b01897ae185d9a4317f52e538f954251be5
-  data.tar.gz: '0483a291cf2029c4011f1f7ecf69f2a89bf83c9c1ad06cfa20ee645b03198416a8222575eef61efbb757c6a959991f612f805cbd02a6fd45184a286fc3043298'
+  metadata.gz: 0cd1f07deaf3c96c42d0682c8bc89185f61c73ff2085a64abd96afe2e983524965433bfdc9ae4586c3c300574a8e3fa67ff680ff4763b6a154d049604dd5ea20
+  data.tar.gz: a577a0b839e3bc484f620b53874817ac9168a6a0409b30d31826a3c1141e28cec6ccae8a3cc1e744bf3942b869a5abf280216aa7ba2f2e96a0f44dcaf035d61a

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.4.11
+- Package version: 3.4.12
 - 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.4.11.gem
+gem install ./ultracart_api-3.4.12.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.4.11.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.4.12.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.4.11'
+    gem 'ultracart_api', '~> 3.4.12'
 
 ### Install from Git
 
@@ -254,6 +254,7 @@ Class | Method | HTTP request | Description
 *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
+*UltracartClient::StorefrontApi* | [**get_email_commseq_webhook_editor_values**](docs/StorefrontApi.md#get_email_commseq_webhook_editor_values) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/webhookEditorValues | Get email webhook editor values
 *UltracartClient::StorefrontApi* | [**get_email_commseqs**](docs/StorefrontApi.md#get_email_commseqs) | **GET** /storefront/{storefront_oid}/email/commseqs | Get email commseqs
 *UltracartClient::StorefrontApi* | [**get_email_customer_editor_url**](docs/StorefrontApi.md#get_email_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/customers/{email_customer_uuid}/editor_url | Get customers editor URL
 *UltracartClient::StorefrontApi* | [**get_email_customers**](docs/StorefrontApi.md#get_email_customers) | **GET** /storefront/{storefront_oid}/email/customers | Get email customers
@@ -716,6 +717,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::EmailVerifyTokenResponse](docs/EmailVerifyTokenResponse.md)
  - [UltracartClient::EmailVerifyTokenValidateRequest](docs/EmailVerifyTokenValidateRequest.md)
  - [UltracartClient::EmailVerifyTokenValidateResponse](docs/EmailVerifyTokenValidateResponse.md)
+ - [UltracartClient::EmailWebhookEditorValuesResponse](docs/EmailWebhookEditorValuesResponse.md)
  - [UltracartClient::Error](docs/Error.md)
  - [UltracartClient::ErrorResponse](docs/ErrorResponse.md)
  - [UltracartClient::Experiment](docs/Experiment.md)
@@ -1112,6 +1114,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.4.12 | 08/10/2021 | email engine - added webhook editor values for internal ui  | 
 | 3.4.9 | 08/05/2021 | configuration api - updated annotations for method names | 
 | 3.4.8 | 08/04/2021 | configuration api - payments config refactoring | 
 | 3.4.7 | 08/04/2021 | esp folders for lists/segments | 

data/docs/EmailWebhookEditorValuesResponse.md

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

data/docs/PaymentsConfigurationCreditCardType.md

@@ -8,10 +8,10 @@ Name | Type | Description | Notes
 **credit_card** | **String** | Credit card type | [optional] 
 **deposit_to_account** | **String** | The name of the account to deposit funds | [optional] 
 **enabled** | **BOOLEAN** | If true, this card type will be accepted during checkout | [optional] 
-**processing_fee** | **String** | Optional additional fee applied to order for this card | [optional] 
-**processing_percentage** | **String** | Optional additional fee applied to order for this card | [optional] 
+**processing_fee** | **Float** | Optional additional fee applied to order for this card | [optional] 
+**processing_percentage** | **Float** | Optional additional fee applied to order for this card | [optional] 
 **surcharge_accounting_code** | **String** | Optional field. If integrated with Quickbooks, this code will be used when informing Quickbooks about any surcharges applied to orders | [optional] 
-**transaction_fee** | **String** | An optional additional fee to charge the customer for using this card. | [optional] 
-**transaction_percentage** | **String** | An optional transaction percentage to charge the customer for using this card | [optional] 
+**transaction_fee** | **Float** | An optional additional fee to charge the customer for using this card. | [optional] 
+**transaction_percentage** | **Float** | An optional transaction percentage to charge the customer for using this card | [optional] 
 
 

data/docs/StorefrontApi.md

@@ -44,6 +44,7 @@ Method | HTTP request | Description
 [**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
+[**get_email_commseq_webhook_editor_values**](StorefrontApi.md#get_email_commseq_webhook_editor_values) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/webhookEditorValues | Get email webhook editor values
 [**get_email_commseqs**](StorefrontApi.md#get_email_commseqs) | **GET** /storefront/{storefront_oid}/email/commseqs | Get email commseqs
 [**get_email_customer_editor_url**](StorefrontApi.md#get_email_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/customers/{email_customer_uuid}/editor_url | Get customers editor URL
 [**get_email_customers**](StorefrontApi.md#get_email_customers) | **GET** /storefront/{storefront_oid}/email/customers | Get email customers
@@ -2193,6 +2194,57 @@ Name | Type | Description  | Notes
 
 
 
+# **get_email_commseq_webhook_editor_values**
+> EmailWebhookEditorValuesResponse get_email_commseq_webhook_editor_values(storefront_oid, commseq_uuid)
+
+Get email webhook 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 | 
+
+commseq_uuid = 'commseq_uuid_example' # String | 
+
+
+begin
+  #Get email webhook editor values
+  result = api_instance.get_email_commseq_webhook_editor_values(storefront_oid, commseq_uuid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->get_email_commseq_webhook_editor_values: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **storefront_oid** | **Integer**|  | 
+ **commseq_uuid** | **String**|  | 
+
+### Return type
+
+[**EmailWebhookEditorValuesResponse**](EmailWebhookEditorValuesResponse.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_commseqs**
 > EmailCommseqsResponse get_email_commseqs(storefront_oid)
 

data/lib/ultracart_api.rb

@@ -315,6 +315,7 @@ require 'ultracart_api/models/email_verify_token_request'
 require 'ultracart_api/models/email_verify_token_response'
 require 'ultracart_api/models/email_verify_token_validate_request'
 require 'ultracart_api/models/email_verify_token_validate_response'
+require 'ultracart_api/models/email_webhook_editor_values_response'
 require 'ultracart_api/models/error'
 require 'ultracart_api/models/error_response'
 require 'ultracart_api/models/experiment'

data/lib/ultracart_api/api/storefront_api.rb

@@ -2369,6 +2369,65 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get email webhook editor values
+    # @param storefront_oid 
+    # @param commseq_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [EmailWebhookEditorValuesResponse]
+    def get_email_commseq_webhook_editor_values(storefront_oid, commseq_uuid, opts = {})
+      data, _status_code, _headers = get_email_commseq_webhook_editor_values_with_http_info(storefront_oid, commseq_uuid, opts)
+      data
+    end
+
+    # Get email webhook editor values
+    # @param storefront_oid 
+    # @param commseq_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailWebhookEditorValuesResponse, Fixnum, Hash)>] EmailWebhookEditorValuesResponse data, response status code and response headers
+    def get_email_commseq_webhook_editor_values_with_http_info(storefront_oid, commseq_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_webhook_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_webhook_editor_values"
+      end
+      # verify the required parameter 'commseq_uuid' is set
+      if @api_client.config.client_side_validation && commseq_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_commseq_webhook_editor_values"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/webhookEditorValues'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_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 => 'EmailWebhookEditorValuesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_webhook_editor_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get email commseqs
     # @param storefront_oid 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/email_webhook_editor_values_response.rb

@@ -0,0 +1,243 @@
+=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 EmailWebhookEditorValuesResponse
+    attr_accessor :available_expansions
+
+    attr_accessor :available_tokens
+
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    attr_accessor :rest_object_type
+
+    # 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
+      {
+        :'available_expansions' => :'available_expansions',
+        :'available_tokens' => :'available_tokens',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'rest_object_type' => :'rest_object_type',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'available_expansions' => :'Array<String>',
+        :'available_tokens' => :'Array<String>',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'rest_object_type' => :'String',
+        :'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?(:'available_expansions')
+        if (value = attributes[:'available_expansions']).is_a?(Array)
+          self.available_expansions = value
+        end
+      end
+
+      if attributes.has_key?(:'available_tokens')
+        if (value = attributes[:'available_tokens']).is_a?(Array)
+          self.available_tokens = value
+        end
+      end
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'rest_object_type')
+        self.rest_object_type = attributes[:'rest_object_type']
+      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 &&
+          available_expansions == o.available_expansions &&
+          available_tokens == o.available_tokens &&
+          error == o.error &&
+          metadata == o.metadata &&
+          rest_object_type == o.rest_object_type &&
+          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
+      [available_expansions, available_tokens, error, metadata, rest_object_type, 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/payments_configuration_credit_card_type.rb

@@ -90,11 +90,11 @@ module UltracartClient
         :'credit_card' => :'String',
         :'deposit_to_account' => :'String',
         :'enabled' => :'BOOLEAN',
-        :'processing_fee' => :'String',
-        :'processing_percentage' => :'String',
+        :'processing_fee' => :'Float',
+        :'processing_percentage' => :'Float',
         :'surcharge_accounting_code' => :'String',
-        :'transaction_fee' => :'String',
-        :'transaction_percentage' => :'String'
+        :'transaction_fee' => :'Float',
+        :'transaction_percentage' => :'Float'
       }
     end
 

data/lib/ultracart_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.4.11
+  version: 3.4.12
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-09 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -506,6 +506,7 @@ files:
 - docs/EmailVerifyTokenResponse.md
 - docs/EmailVerifyTokenValidateRequest.md
 - docs/EmailVerifyTokenValidateResponse.md
+- docs/EmailWebhookEditorValuesResponse.md
 - docs/Error.md
 - docs/ErrorResponse.md
 - docs/Experiment.md
@@ -1168,6 +1169,7 @@ files:
 - lib/ultracart_api/models/email_verify_token_response.rb
 - lib/ultracart_api/models/email_verify_token_validate_request.rb
 - lib/ultracart_api/models/email_verify_token_validate_response.rb
+- lib/ultracart_api/models/email_webhook_editor_values_response.rb
 - lib/ultracart_api/models/error.rb
 - lib/ultracart_api/models/error_response.rb
 - lib/ultracart_api/models/experiment.rb