aftership-tracking-sdk 7.0.0 → 9.0.0

data/lib/aftership-tracking-sdk/api_client.rb

@@ -44,7 +44,7 @@ module AftershipAPI
       begin
         call_api_internal(http_method, path, opts)
       rescue ApiError => e
-        if retries > 0 && (e.error_code == AftershipAPI::TIMED_OUT || e.status_code >= 500)
+        if retries > 0 && (e.error_code == AftershipAPI::TIMED_OUT || e.status_code >= 500 )
           retries -= 1
           delay_with_jitter
           retry
@@ -109,7 +109,7 @@ module AftershipAPI
       url = build_request_url(path, opts)
       http_method = http_method.to_sym.downcase
 
-      header_params = @default_headers.merge(opts[:header_params] || {}).merge({ 'as-api-key' => config.as_api_key })
+      header_params = @default_headers.merge(opts[:header_params] || {}).merge({'as-api-key' => config.as_api_key})
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
       follow_location = opts[:follow_location] || true

data/lib/aftership-tracking-sdk/configuration.rb

@@ -4,119 +4,119 @@ require 'uri'
 require 'typhoeus'
 
 module AftershipAPI
-  AUTHENTICATION_TYPE_API_KEY = 'API_KEY'
-  AUTHENTICATION_TYPE_AES = 'AES'
-  AUTHENTICATION_TYPE_RSA = 'RSA'
-  
-  SDK_PREFIX = 'AFTERSHIP_TRACKING_SDK'
-  
-  
-  class Configuration
-    def get_env(key)
-      ENV[SDK_PREFIX + '_' + key]
-    end
-  
-    # Defines domain
-    attr_accessor :domain
-  
-    # Defines the authentication type used in the API.
-    #
-    # @return ["API_KEY", "AES", "RSA"]
-    attr_accessor :authentication_type
-  
-    # Defines API keys used with API Key authentications.
-    #
-    # @return [string]
-    attr_accessor :as_api_key
-  
-    # Defines AES secret or RSA private key used with AES or RSA authentications.
-    #
-    # @return [string]
-    attr_accessor :as_api_secret
-  
-    # Defines the user agent used in the API requests.
-    # Default to 'aftership-sdk-ruby/$VERSION'
-    #
-    # @return [string]
-    attr_accessor :user_agent
-  
-    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
-    # details will be logged with `logger.debug` (see the `logger` attribute).
-    # Default to false.
-    #
-    # @return [true, false]
-    attr_accessor :debugging
-  
-    # Defines the logger used for debugging.
-    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
-    #
-    # @return [#debug]
-    attr_accessor :logger
-  
-    # The time limit for HTTP request in seconds.
-    # Default to 30 
-    attr_accessor :timeout
-  
-    # When response is a retryable error, retry current request
-    # Default to 2
-    attr_accessor :max_retry
-  
-    # HTTP proxy
-    attr_accessor :proxy
+	AUTHENTICATION_TYPE_API_KEY = 'API_KEY'
+	AUTHENTICATION_TYPE_AES = 'AES'
+	AUTHENTICATION_TYPE_RSA = 'RSA'
+  
+	SDK_PREFIX = 'AFTERSHIP_TRACKING_SDK'
+  
+	
+	class Configuration
+	  def get_env(key)
+		ENV[SDK_PREFIX + '_' + key]
+	  end
+  
+	  # Defines domain
+	  attr_accessor :domain
+  
+	  # Defines the authentication type used in the API.
+	  #
+	  # @return ["API_KEY", "AES", "RSA"]
+	  attr_accessor :authentication_type
+  
+	  # Defines API keys used with API Key authentications.
+	  #
+	  # @return [string]
+	  attr_accessor :as_api_key
+  
+	  # Defines AES secret or RSA private key used with AES or RSA authentications.
+	  #
+	  # @return [string]
+	  attr_accessor :as_api_secret
+  
+	  # Defines the user agent used in the API requests.
+	  # Default to 'aftership-sdk-ruby/$VERSION'
+	  #
+	  # @return [string]
+	  attr_accessor :user_agent
+  
+	  # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+	  # details will be logged with `logger.debug` (see the `logger` attribute).
+	  # Default to false.
+	  #
+	  # @return [true, false]
+	  attr_accessor :debugging
+  
+	  # Defines the logger used for debugging.
+	  # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+	  #
+	  # @return [#debug]
+	  attr_accessor :logger
+  
+	  # The time limit for HTTP request in seconds.
+	  # Default to 30 
+	  attr_accessor :timeout
+  
+	  # When response is a retryable error, retry current request
+	  # Default to 2
+	  attr_accessor :max_retry
+  
+	  # HTTP proxy
+	  attr_accessor :proxy
 
-    attr_accessor :aftership_client
+	  attr_accessor :aftership_client
 
-    attr_accessor :headers
+	  attr_accessor :headers
   
   
-    def initialize
-      default_user_agent = "aftership-sdk-ruby/#{AftershipAPI::VERSION} (https://www.aftership.com) typhoeus/#{Typhoeus::VERSION}"
+	  def initialize
+	  	default_user_agent = "aftership-sdk-ruby/#{AftershipAPI::VERSION} (https://www.aftership.com) typhoeus/#{Typhoeus::VERSION}"
 
-      @domain = get_env('DOMAIN') || 'https://api.aftership.com'
-      @authentication_type = get_env('AUTHENTICATION_TYPE') || AUTHENTICATION_TYPE_API_KEY
-      @as_api_key = get_env('API_KEY') || ''
-      @as_api_secret = get_env('API_SECRET') || ''
-      @user_agent = get_env('USER_AGENT') || default_user_agent
-      @aftership_client = default_user_agent
-      @timeout = (get_env('TIMEOUT') || 30).to_i
-      @max_retry = (get_env('MAX_RETRY') || 2).to_i
-      @proxy = get_env('PROXY')
-      @debugging = get_env('DEBUGGING') || false
-      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
-      @headers = {}
+		@domain = get_env('DOMAIN') || 'https://api.aftership.com'
+		@authentication_type = get_env('AUTHENTICATION_TYPE') || AUTHENTICATION_TYPE_API_KEY
+		@as_api_key = get_env('API_KEY') || ''
+		@as_api_secret = get_env('API_SECRET') || ''
+		@user_agent = get_env('USER_AGENT') || default_user_agent
+		@aftership_client = default_user_agent
+		@timeout = (get_env('TIMEOUT') || 30).to_i
+		@max_retry = (get_env('MAX_RETRY') || 2).to_i
+		@proxy = get_env('PROXY')
+		@debugging = get_env('DEBUGGING') || false
+		@logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+		@headers = {}
 
-      yield(self) if block_given?
-    end
-  
-    # The default Configuration object.
-    def self.default
-      @@default ||= Configuration.new
-    end
-  
-    def configure
-      yield(self) if block_given?
-    end
-  
-    def domain=(domain)
-      @domain = domain.sub(/\/+\z/, '')
-    end
-  
-    def check
-      fail InvalidOptionError.new("Invalid authentication type: #{authentication_type}") unless [AUTHENTICATION_TYPE_API_KEY, AUTHENTICATION_TYPE_AES, AUTHENTICATION_TYPE_RSA].include?(authentication_type)
-      fail InvalidOptionError.new("as_api_key cannot be empty") unless as_api_key.to_s.size > 0
-      fail InvalidOptionError.new("Invalid base URL: #{domain}") unless valid_url?(domain)
-      fail InvalidOptionError.new("authentication type must not be API_KEY if as_api_secret is set") if as_api_secret.to_s.size > 0 && authentication_type == AUTHENTICATION_TYPE_API_KEY
-      fail InvalidOptionError.new("timeout cannot be negative, value #{timeout}") unless timeout.to_i >= 0
-      fail InvalidOptionError.new("max_retry must be in range 0..10, value #{max_retry}") unless (max_retry.to_i >= 0) && (max_retry.to_i <= 10)
-      fail InvalidOptionError.new("max_retry cannot be negative, value #{max_retry}") unless max_retry.to_i >= 0
-    end
-  
-    def valid_url?(url)
-      uri = URI.parse(url)
-      uri.is_a?(URI::HTTP) || uri.is_a?(URI::HTTPS)
-      rescue URI::InvalidURIError
-        false
-    end
+		yield(self) if block_given?
+	  end
+  
+	  # The default Configuration object.
+	  def self.default
+		@@default ||= Configuration.new
+	  end
+  
+	  def configure
+		yield(self) if block_given?
+	  end
+  
+	  def domain=(domain)
+		@domain = domain.sub(/\/+\z/, '')
+	  end
+  
+	  def check
+		fail InvalidOptionError.new("Invalid authentication type: #{authentication_type}") unless [AUTHENTICATION_TYPE_API_KEY, AUTHENTICATION_TYPE_AES, AUTHENTICATION_TYPE_RSA].include?(authentication_type)
+		fail InvalidOptionError.new("as_api_key cannot be empty") unless as_api_key.to_s.size > 0
+		fail InvalidOptionError.new("Invalid base URL: #{domain}") unless valid_url?(domain)
+		fail InvalidOptionError.new("authentication type must not be API_KEY if as_api_secret is set") if as_api_secret.to_s.size > 0 && authentication_type == AUTHENTICATION_TYPE_API_KEY
+		fail InvalidOptionError.new("timeout cannot be negative, value #{timeout}") unless timeout.to_i >= 0
+		fail InvalidOptionError.new("max_retry must be in range 0..10, value #{max_retry}") unless max_retry.to_i >= 0 and max_retry.to_i <=10
+		fail InvalidOptionError.new("max_retry cannot be negative, value #{max_retry}") unless max_retry.to_i >= 0
+	  end
+  
+	  def valid_url?(url)
+		uri = URI.parse(url)
+		uri.is_a?(URI::HTTP) || uri.is_a?(URI::HTTPS)
+	  rescue URI::InvalidURIError
+		false
+	  end
+	end
   end
-end
   

data/lib/aftership-tracking-sdk/models/additional_fields_v1.rb

@@ -11,7 +11,7 @@ module AftershipAPI::Model
     TRACKING_DESTINATION_COUNTRY = "tracking_destination_country".freeze
     TRACKING_STATE = "tracking_state".freeze
     def self.all_vars
-      @all_vars ||= [TRACKING_ACCOUNT_NUMBER, TRACKING_POSTAL_CODE, TRACKING_SHIP_DATE, TRACKING_KEY, TRACKING_ORIGIN_COUNTRY, TRACKING_DESTINATION_COUNTRY, TRACKING_STATE,].freeze
+      @all_vars ||= [TRACKING_ACCOUNT_NUMBER,TRACKING_POSTAL_CODE,TRACKING_SHIP_DATE,TRACKING_KEY,TRACKING_ORIGIN_COUNTRY,TRACKING_DESTINATION_COUNTRY,TRACKING_STATE,].freeze
     end
 
     # Builds the enum from string

data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_create_tracking_response.rb

@@ -0,0 +1,183 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class AftershipEstimatedDeliveryDateCreateTrackingResponse
+
+    # The estimated arrival date of the shipment.
+    # estimated_delivery_date?: String;
+    attr_accessor :estimated_delivery_date
+
+    # Indicates the confidence level and associated reason for an AI EDD prediction request. For a comprehensive list of confidence codes, refer to .
+    # confidence_code?: Float;
+    attr_accessor :confidence_code
+
+    # Earliest estimated delivery date of the shipment.
+    # estimated_delivery_date_min?: String;
+    attr_accessor :estimated_delivery_date_min
+
+    # Latest estimated delivery date of the shipment.
+    # estimated_delivery_date_max?: String;
+    attr_accessor :estimated_delivery_date_max
+
+    # 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 `AftershipAPI::AftershipEstimatedDeliveryDateCreateTrackingResponse` initialize method"
+      end
+
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'estimated_delivery_date')
+        self.estimated_delivery_date = attributes[:'estimated_delivery_date']
+      end 
+
+      if attributes.key?(:'confidence_code')
+        self.confidence_code = attributes[:'confidence_code']
+      end 
+
+      if attributes.key?(:'estimated_delivery_date_min')
+        self.estimated_delivery_date_min = attributes[:'estimated_delivery_date_min']
+      end 
+
+      if attributes.key?(:'estimated_delivery_date_max')
+        self.estimated_delivery_date_max = attributes[:'estimated_delivery_date_max']
+      end 
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'estimated_delivery_date' => :'String',
+        :'confidence_code' => :'Float',
+        :'estimated_delivery_date_min' => :'String',
+        :'estimated_delivery_date_max' => :'String',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'estimated_delivery_date' => :'estimated_delivery_date',
+        :'confidence_code' => :'confidence_code',
+        :'estimated_delivery_date_min' => :'estimated_delivery_date_min',
+        :'estimated_delivery_date_max' => :'estimated_delivery_date_max',
+      }
+    end
+
+    # Builds the object from hash
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(key) && attributes[key].nil?
+          transformed_hash["#{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[key].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[key].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[key].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[key])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param type [String] Data type
+    # @param value [String] Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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
+        klass = AftershipAPI::Model.const_get(type)
+        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)
+        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 value [Object] 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
+
+    def to_json(*a)
+      to_hash.to_json(*a)
+    end
+  end
+end
+

data/lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_delete_tracking_by_id_response.rb

@@ -0,0 +1,183 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class AftershipEstimatedDeliveryDateDeleteTrackingByIdResponse
+
+    # The estimated arrival date of the shipment.
+    # estimated_delivery_date?: String;
+    attr_accessor :estimated_delivery_date
+
+    # Indicates the confidence level and associated reason for an AI EDD prediction request. For a comprehensive list of confidence codes, refer to .
+    # confidence_code?: Float;
+    attr_accessor :confidence_code
+
+    # Earliest estimated delivery date of the shipment.
+    # estimated_delivery_date_min?: String;
+    attr_accessor :estimated_delivery_date_min
+
+    # Latest estimated delivery date of the shipment.
+    # estimated_delivery_date_max?: String;
+    attr_accessor :estimated_delivery_date_max
+
+    # 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 `AftershipAPI::AftershipEstimatedDeliveryDateDeleteTrackingByIdResponse` initialize method"
+      end
+
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'estimated_delivery_date')
+        self.estimated_delivery_date = attributes[:'estimated_delivery_date']
+      end 
+
+      if attributes.key?(:'confidence_code')
+        self.confidence_code = attributes[:'confidence_code']
+      end 
+
+      if attributes.key?(:'estimated_delivery_date_min')
+        self.estimated_delivery_date_min = attributes[:'estimated_delivery_date_min']
+      end 
+
+      if attributes.key?(:'estimated_delivery_date_max')
+        self.estimated_delivery_date_max = attributes[:'estimated_delivery_date_max']
+      end 
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'estimated_delivery_date' => :'String',
+        :'confidence_code' => :'Float',
+        :'estimated_delivery_date_min' => :'String',
+        :'estimated_delivery_date_max' => :'String',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'estimated_delivery_date' => :'estimated_delivery_date',
+        :'confidence_code' => :'confidence_code',
+        :'estimated_delivery_date_min' => :'estimated_delivery_date_min',
+        :'estimated_delivery_date_max' => :'estimated_delivery_date_max',
+      }
+    end
+
+    # Builds the object from hash
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(key) && attributes[key].nil?
+          transformed_hash["#{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[key].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[key].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[key].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[key])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param type [String] Data type
+    # @param value [String] Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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
+        klass = AftershipAPI::Model.const_get(type)
+        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)
+        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 value [Object] 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
+
+    def to_json(*a)
+      to_hash.to_json(*a)
+    end
+  end
+end
+