ultracart_api 4.1.86 → 4.1.88

data/lib/ultracart_api/api/order_api.rb

@@ -1236,6 +1236,134 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Retrieve email delivery information for this order.
+    # Retrieves email delivery records associated with the specified order id. 
+    # @param order_id [String] The order id to retrieve email delivery information for.
+    # @param [Hash] opts the optional parameters
+    # @return [OrderEmailsResponse]
+    def get_order_emails(order_id, opts = {})
+      data, _status_code, _headers = get_order_emails_with_http_info(order_id, opts)
+      data
+    end
+
+    # Retrieve email delivery information for this order.
+    # Retrieves email delivery records associated with the specified order id. 
+    # @param order_id [String] The order id to retrieve email delivery information for.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrderEmailsResponse, Integer, Hash)>] OrderEmailsResponse data, response status code and response headers
+    def get_order_emails_with_http_info(order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.get_order_emails ...'
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_order_emails"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/emails'.sub('{' + 'order_id' + '}', CGI.escape(order_id.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] || 'OrderEmailsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.get_order_emails",
+        :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: OrderApi#get_order_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve page view history for this order.
+    # Retrieves the page views captured during the session that placed this order. 
+    # @param order_id [String] The order id to retrieve page view history for.
+    # @param [Hash] opts the optional parameters
+    # @return [OrderPageViewHistoryResponse]
+    def get_order_page_view_history(order_id, opts = {})
+      data, _status_code, _headers = get_order_page_view_history_with_http_info(order_id, opts)
+      data
+    end
+
+    # Retrieve page view history for this order.
+    # Retrieves the page views captured during the session that placed this order. 
+    # @param order_id [String] The order id to retrieve page view history for.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrderPageViewHistoryResponse, Integer, Hash)>] OrderPageViewHistoryResponse data, response status code and response headers
+    def get_order_page_view_history_with_http_info(order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.get_order_page_view_history ...'
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.get_order_page_view_history"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/page_view_history'.sub('{' + 'order_id' + '}', CGI.escape(order_id.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] || 'OrderPageViewHistoryResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.get_order_page_view_history",
+        :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: OrderApi#get_order_page_view_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get Order Upsell Cart
     # Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to 
     # @param order_id [String] The order id to base things on.

data/lib/ultracart_api/models/auto_order.rb

@@ -51,6 +51,9 @@ module UltracartClient
     # The date/time the auto order was disabled due to failed rebills
     attr_accessor :disabled_dts
 
+    # Email delivery records associated with this auto order.
+    attr_accessor :emails
+
     # True if this auto order is enabled
     attr_accessor :enabled
 
@@ -134,6 +137,7 @@ module UltracartClient
         :'completed' => :'completed',
         :'credit_card_attempt' => :'credit_card_attempt',
         :'disabled_dts' => :'disabled_dts',
+        :'emails' => :'emails',
         :'enabled' => :'enabled',
         :'failure_reason' => :'failure_reason',
         :'items' => :'items',
@@ -173,6 +177,7 @@ module UltracartClient
         :'completed' => :'Boolean',
         :'credit_card_attempt' => :'Integer',
         :'disabled_dts' => :'String',
+        :'emails' => :'Array<AutoOrderEmail>',
         :'enabled' => :'Boolean',
         :'failure_reason' => :'String',
         :'items' => :'Array<AutoOrderItem>',
@@ -263,6 +268,12 @@ module UltracartClient
         self.disabled_dts = attributes[:'disabled_dts']
       end
 
+      if attributes.key?(:'emails')
+        if (value = attributes[:'emails']).is_a?(Array)
+          self.emails = value
+        end
+      end
+
       if attributes.key?(:'enabled')
         self.enabled = attributes[:'enabled']
       end
@@ -378,6 +389,7 @@ module UltracartClient
           completed == o.completed &&
           credit_card_attempt == o.credit_card_attempt &&
           disabled_dts == o.disabled_dts &&
+          emails == o.emails &&
           enabled == o.enabled &&
           failure_reason == o.failure_reason &&
           items == o.items &&
@@ -405,7 +417,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [add_ons, auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, logs, management, merchant_id, merged_dts, merged_into_auto_order_oid, next_attempt, original_order, original_order_id, override_affiliate_id, properties, rebill_orders, rotating_transaction_gateway_code, status].hash
+      [add_ons, auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, emails, enabled, failure_reason, items, logs, management, merchant_id, merged_dts, merged_into_auto_order_oid, next_attempt, original_order, original_order_id, override_affiliate_id, properties, rebill_orders, rotating_transaction_gateway_code, status].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/auto_order_email.rb

@@ -0,0 +1,402 @@
+=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 AutoOrderEmail
+    attr_accessor :bounce_diagnostic_code
+
+    # Date/time that the email was bounced
+    attr_accessor :bounce_dts
+
+    attr_accessor :bounce_sub_type
+
+    attr_accessor :bounce_type
+
+    attr_accessor :clicked
+
+    # Date/time that the email was clicked
+    attr_accessor :clicked_dts
+
+    attr_accessor :delivered
+
+    # Date/time that the email was delivered
+    attr_accessor :delivery_dts
+
+    # Email
+    attr_accessor :email
+
+    attr_accessor :internal
+
+    attr_accessor :message_id
+
+    attr_accessor :opened
+
+    # Date/time that the email was opened
+    attr_accessor :opened_dts
+
+    attr_accessor :reporting_mta
+
+    # Date/time that the email was sent
+    attr_accessor :send_dts
+
+    attr_accessor :skip_reason
+
+    attr_accessor :skipped
+
+    attr_accessor :smtp_response
+
+    attr_accessor :subject
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'bounce_diagnostic_code' => :'bounce_diagnostic_code',
+        :'bounce_dts' => :'bounce_dts',
+        :'bounce_sub_type' => :'bounce_sub_type',
+        :'bounce_type' => :'bounce_type',
+        :'clicked' => :'clicked',
+        :'clicked_dts' => :'clicked_dts',
+        :'delivered' => :'delivered',
+        :'delivery_dts' => :'delivery_dts',
+        :'email' => :'email',
+        :'internal' => :'internal',
+        :'message_id' => :'message_id',
+        :'opened' => :'opened',
+        :'opened_dts' => :'opened_dts',
+        :'reporting_mta' => :'reporting_mta',
+        :'send_dts' => :'send_dts',
+        :'skip_reason' => :'skip_reason',
+        :'skipped' => :'skipped',
+        :'smtp_response' => :'smtp_response',
+        :'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
+      {
+        :'bounce_diagnostic_code' => :'String',
+        :'bounce_dts' => :'String',
+        :'bounce_sub_type' => :'String',
+        :'bounce_type' => :'String',
+        :'clicked' => :'Boolean',
+        :'clicked_dts' => :'String',
+        :'delivered' => :'Boolean',
+        :'delivery_dts' => :'String',
+        :'email' => :'String',
+        :'internal' => :'Boolean',
+        :'message_id' => :'String',
+        :'opened' => :'Boolean',
+        :'opened_dts' => :'String',
+        :'reporting_mta' => :'String',
+        :'send_dts' => :'String',
+        :'skip_reason' => :'String',
+        :'skipped' => :'Boolean',
+        :'smtp_response' => :'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::AutoOrderEmail` 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::AutoOrderEmail`. 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?(:'bounce_diagnostic_code')
+        self.bounce_diagnostic_code = attributes[:'bounce_diagnostic_code']
+      end
+
+      if attributes.key?(:'bounce_dts')
+        self.bounce_dts = attributes[:'bounce_dts']
+      end
+
+      if attributes.key?(:'bounce_sub_type')
+        self.bounce_sub_type = attributes[:'bounce_sub_type']
+      end
+
+      if attributes.key?(:'bounce_type')
+        self.bounce_type = attributes[:'bounce_type']
+      end
+
+      if attributes.key?(:'clicked')
+        self.clicked = attributes[:'clicked']
+      end
+
+      if attributes.key?(:'clicked_dts')
+        self.clicked_dts = attributes[:'clicked_dts']
+      end
+
+      if attributes.key?(:'delivered')
+        self.delivered = attributes[:'delivered']
+      end
+
+      if attributes.key?(:'delivery_dts')
+        self.delivery_dts = attributes[:'delivery_dts']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'internal')
+        self.internal = attributes[:'internal']
+      end
+
+      if attributes.key?(:'message_id')
+        self.message_id = attributes[:'message_id']
+      end
+
+      if attributes.key?(:'opened')
+        self.opened = attributes[:'opened']
+      end
+
+      if attributes.key?(:'opened_dts')
+        self.opened_dts = attributes[:'opened_dts']
+      end
+
+      if attributes.key?(:'reporting_mta')
+        self.reporting_mta = attributes[:'reporting_mta']
+      end
+
+      if attributes.key?(:'send_dts')
+        self.send_dts = attributes[:'send_dts']
+      end
+
+      if attributes.key?(:'skip_reason')
+        self.skip_reason = attributes[:'skip_reason']
+      end
+
+      if attributes.key?(:'skipped')
+        self.skipped = attributes[:'skipped']
+      end
+
+      if attributes.key?(:'smtp_response')
+        self.smtp_response = attributes[:'smtp_response']
+      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
+      if !@email.nil? && @email.to_s.length > 100
+        invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 100.')
+      end
+
+      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?
+      return false if !@email.nil? && @email.to_s.length > 100
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      if !email.nil? && email.to_s.length > 100
+        fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 100.'
+      end
+
+      @email = email
+    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 &&
+          bounce_diagnostic_code == o.bounce_diagnostic_code &&
+          bounce_dts == o.bounce_dts &&
+          bounce_sub_type == o.bounce_sub_type &&
+          bounce_type == o.bounce_type &&
+          clicked == o.clicked &&
+          clicked_dts == o.clicked_dts &&
+          delivered == o.delivered &&
+          delivery_dts == o.delivery_dts &&
+          email == o.email &&
+          internal == o.internal &&
+          message_id == o.message_id &&
+          opened == o.opened &&
+          opened_dts == o.opened_dts &&
+          reporting_mta == o.reporting_mta &&
+          send_dts == o.send_dts &&
+          skip_reason == o.skip_reason &&
+          skipped == o.skipped &&
+          smtp_response == o.smtp_response &&
+          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
+      [bounce_diagnostic_code, bounce_dts, bounce_sub_type, bounce_type, clicked, clicked_dts, delivered, delivery_dts, email, internal, message_id, opened, opened_dts, reporting_mta, send_dts, skip_reason, skipped, smtp_response, 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