ultracart_api 4.1.164 → 4.1.167

data/lib/ultracart_api/api/storefront_api.rb

@@ -5661,6 +5661,149 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get the review status of an email
+    # @param storefront_oid [Integer] 
+    # @param commseq_email_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [EmailCommseqEmailReviewStatusResponse]
+    def get_email_review_status(storefront_oid, commseq_email_uuid, opts = {})
+      data, _status_code, _headers = get_email_review_status_with_http_info(storefront_oid, commseq_email_uuid, opts)
+      data
+    end
+
+    # Get the review status of an email
+    # @param storefront_oid [Integer] 
+    # @param commseq_email_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailCommseqEmailReviewStatusResponse, Integer, Hash)>] EmailCommseqEmailReviewStatusResponse data, response status code and response headers
+    def get_email_review_status_with_http_info(storefront_oid, commseq_email_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_review_status ...'
+      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_review_status"
+      end
+      # verify the required parameter 'commseq_email_uuid' is set
+      if @api_client.config.client_side_validation && commseq_email_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'commseq_email_uuid' when calling StorefrontApi.get_email_review_status"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review_status'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_email_uuid' + '}', CGI.escape(commseq_email_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[: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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EmailCommseqEmailReviewStatusResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.get_email_review_status",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_email_review_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get the review status of multiple emails
+    # Returns one entry per requested email, in the order requested, so a caller polling a campaign does not have to reconcile a short response. 
+    # @param storefront_oid [Integer] 
+    # @param email_commseq_email_review_statuses_request [EmailCommseqEmailReviewStatusesRequest] Request of email uuids
+    # @param [Hash] opts the optional parameters
+    # @return [EmailCommseqEmailReviewStatusesResponse]
+    def get_email_review_statuses_multiple(storefront_oid, email_commseq_email_review_statuses_request, opts = {})
+      data, _status_code, _headers = get_email_review_statuses_multiple_with_http_info(storefront_oid, email_commseq_email_review_statuses_request, opts)
+      data
+    end
+
+    # Get the review status of multiple emails
+    # Returns one entry per requested email, in the order requested, so a caller polling a campaign does not have to reconcile a short response. 
+    # @param storefront_oid [Integer] 
+    # @param email_commseq_email_review_statuses_request [EmailCommseqEmailReviewStatusesRequest] Request of email uuids
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailCommseqEmailReviewStatusesResponse, Integer, Hash)>] EmailCommseqEmailReviewStatusesResponse data, response status code and response headers
+    def get_email_review_statuses_multiple_with_http_info(storefront_oid, email_commseq_email_review_statuses_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_review_statuses_multiple ...'
+      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_review_statuses_multiple"
+      end
+      # verify the required parameter 'email_commseq_email_review_statuses_request' is set
+      if @api_client.config.client_side_validation && email_commseq_email_review_statuses_request.nil?
+        fail ArgumentError, "Missing the required parameter 'email_commseq_email_review_statuses_request' when calling StorefrontApi.get_email_review_statuses_multiple"
+      end
+      # resource path
+      local_var_path = '/storefront/{storefront_oid}/email/emails/review_status/multiple'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[: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'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_email_review_statuses_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EmailCommseqEmailReviewStatusesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.get_email_review_statuses_multiple",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_email_review_statuses_multiple\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get email segment
     # @param storefront_oid [Integer] 
     # @param email_segment_uuid [String] 

data/lib/ultracart_api/models/email_commseq_email_review_status.rb

@@ -0,0 +1,324 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class EmailCommseqEmailReviewStatus
+    # Date the review was approved or rejected
+    attr_accessor :decided_dts
+
+    # Review UUID
+    attr_accessor :esp_commseq_email_review_uuid
+
+    # Email communication sequence email UUID
+    attr_accessor :esp_commseq_email_uuid
+
+    # Email communication sequence UUID
+    attr_accessor :esp_commseq_uuid
+
+    # Why the email was rejected, and what to change. Only present when the state is rejected.
+    attr_accessor :rejection_reason
+
+    # Date the review was requested
+    attr_accessor :requested_dts
+
+    # State of the review
+    attr_accessor :state
+
+    # Subject of the email as it was reviewed
+    attr_accessor :subject
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'decided_dts' => :'decided_dts',
+        :'esp_commseq_email_review_uuid' => :'esp_commseq_email_review_uuid',
+        :'esp_commseq_email_uuid' => :'esp_commseq_email_uuid',
+        :'esp_commseq_uuid' => :'esp_commseq_uuid',
+        :'rejection_reason' => :'rejection_reason',
+        :'requested_dts' => :'requested_dts',
+        :'state' => :'state',
+        :'subject' => :'subject'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'decided_dts' => :'String',
+        :'esp_commseq_email_review_uuid' => :'String',
+        :'esp_commseq_email_uuid' => :'String',
+        :'esp_commseq_uuid' => :'String',
+        :'rejection_reason' => :'String',
+        :'requested_dts' => :'String',
+        :'state' => :'String',
+        :'subject' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::EmailCommseqEmailReviewStatus` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::EmailCommseqEmailReviewStatus`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'decided_dts')
+        self.decided_dts = attributes[:'decided_dts']
+      end
+
+      if attributes.key?(:'esp_commseq_email_review_uuid')
+        self.esp_commseq_email_review_uuid = attributes[:'esp_commseq_email_review_uuid']
+      end
+
+      if attributes.key?(:'esp_commseq_email_uuid')
+        self.esp_commseq_email_uuid = attributes[:'esp_commseq_email_uuid']
+      end
+
+      if attributes.key?(:'esp_commseq_uuid')
+        self.esp_commseq_uuid = attributes[:'esp_commseq_uuid']
+      end
+
+      if attributes.key?(:'rejection_reason')
+        self.rejection_reason = attributes[:'rejection_reason']
+      end
+
+      if attributes.key?(:'requested_dts')
+        self.requested_dts = attributes[:'requested_dts']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      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?
+      state_validator = EnumAttributeValidator.new('String', ["not_submitted", "pending", "approved", "rejected"])
+      return false unless state_validator.valid?(@state)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ["not_submitted", "pending", "approved", "rejected"])
+      unless validator.valid?(state)
+        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      end
+      @state = state
+    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 &&
+          decided_dts == o.decided_dts &&
+          esp_commseq_email_review_uuid == o.esp_commseq_email_review_uuid &&
+          esp_commseq_email_uuid == o.esp_commseq_email_uuid &&
+          esp_commseq_uuid == o.esp_commseq_uuid &&
+          rejection_reason == o.rejection_reason &&
+          requested_dts == o.requested_dts &&
+          state == o.state &&
+          subject == o.subject
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [decided_dts, esp_commseq_email_review_uuid, esp_commseq_email_uuid, esp_commseq_uuid, rejection_reason, requested_dts, state, subject].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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