aftership-tracking-sdk 7.0.0 → 9.0.0

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class DestinationAddressEstimatedDeliveryDateRequest
+
     # The country/region of the destination location where the package will be delivered. Use 3 letters of ISO 3166-1 country code.
     # country: String;
     attr_accessor :country
@@ -189,3 +190,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class DestinationAddressEstimatedDeliveryDateResponse
+
     # The country/region of the destination location where the package will be delivered. Use 3 letters of ISO 3166-1 country code.
     # country: String;
     attr_accessor :country
@@ -189,3 +190,4 @@ module AftershipAPI::Model
     end
   end
 end
+

data/lib/aftership-tracking-sdk/models/{tracking_detect_courier_request.rb → detect_courier_request.rb}

@@ -1,12 +1,13 @@
 # This code was auto generated by AfterShip SDK Generator.
 # Do not edit the class manually.
 module AftershipAPI::Model
-  class TrackingDetectCourierRequest
+  class DetectCourierRequest
+
     # Tracking number of a shipment.
     # tracking_number: String;
     attr_accessor :tracking_number
 
-    # If not specified, Aftership will automatically detect the courier based on the tracking number format and your . Use array or comma separated to input a list of couriers for auto detect. Cannot be used with slug_group at the same time.
+    # If not specified, Aftership will automatically detect the courier based on the tracking number format and your . Use array to input a list of couriers for auto detect. Cannot be used with slug_group at the same time.
     # slug?: String[];
     attr_accessor :slug
 
@@ -54,7 +55,7 @@ module AftershipAPI::Model
     # @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::TrackingDetectCourierRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::DetectCourierRequest` initialize method"
       end
 
       attributes = attributes.each_with_object({}) { |(k, v), h|
@@ -259,3 +260,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class DetectCourierResponse
+
     # Total count of courier objects
     # total?: Integer;
     attr_accessor :total
@@ -159,3 +160,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class EstimatedDeliveryDateRequest
+
     # AfterShip's unique code of courier. Please refer to https://track.aftership.com/couriers/download.
     # slug: String;
     attr_accessor :slug
@@ -219,3 +220,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,11 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class EstimatedDeliveryDateResponse
+
+    # A string that acts as a unique identifier for the estimated delivery date value generated by AfterShip Predict API
+    # id: String;
+    attr_accessor :id
+
     # AfterShip's unique code of courier. Please refer to https://track.aftership.com/couriers/download.
     # slug: String;
     attr_accessor :slug
@@ -61,6 +66,10 @@ module AftershipAPI::Model
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end 
+
       if attributes.key?(:'slug')
         self.slug = attributes[:'slug']
       end 
@@ -113,6 +122,7 @@ module AftershipAPI::Model
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'id' => :'String',
         :'slug' => :'String',
         :'service_type_name' => :'String',
         :'origin_address' => :'OriginAddressEstimatedDeliveryDateResponse',
@@ -131,6 +141,7 @@ module AftershipAPI::Model
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'id' => :'id',
         :'slug' => :'slug',
         :'service_type_name' => :'service_type_name',
         :'origin_address' => :'origin_address',
@@ -259,3 +270,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class EstimatedPickupEstimatedDeliveryDateRequest
+
     # The local order time in the origin address time zone of the package.
     # order_time: String;
     attr_accessor :order_time
@@ -179,3 +180,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class EstimatedPickupEstimatedDeliveryDateResponse
+
     # The local order time in the origin address time zone of the package.
     # order_time: String;
     attr_accessor :order_time
@@ -189,3 +190,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class EventsCheckpoint
+
     # Represents the event code.
     # code?: String;
     attr_accessor :code
@@ -159,3 +160,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -0,0 +1,193 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class FirstEstimatedDeliveryCreateTrackingResponse
+
+    # The format of the EDD. Either a single date or a date range.
+    # type?: String;
+    attr_accessor :type
+
+    # The source of the EDD. Either the carrier, AfterShip AI, or based on your custom EDD settings.
+    # source?: String;
+    attr_accessor :source
+
+    # The latest EDD time.
+    # datetime?: String;
+    attr_accessor :datetime
+
+    # For a date range EDD format, the date and time for the lower end of the range.
+    # datetime_min?: String;
+    attr_accessor :datetime_min
+
+    # For a date range EDD format, the date and time for the upper end of the range.
+    # datetime_max?: String;
+    attr_accessor :datetime_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::FirstEstimatedDeliveryCreateTrackingResponse` initialize method"
+      end
+
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end 
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      end 
+
+      if attributes.key?(:'datetime')
+        self.datetime = attributes[:'datetime']
+      end 
+
+      if attributes.key?(:'datetime_min')
+        self.datetime_min = attributes[:'datetime_min']
+      end 
+
+      if attributes.key?(:'datetime_max')
+        self.datetime_max = attributes[:'datetime_max']
+      end 
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'source' => :'String',
+        :'datetime' => :'String',
+        :'datetime_min' => :'String',
+        :'datetime_max' => :'String',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'source' => :'source',
+        :'datetime' => :'datetime',
+        :'datetime_min' => :'datetime_min',
+        :'datetime_max' => :'datetime_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/first_estimated_delivery_delete_tracking_by_id_response.rb

@@ -0,0 +1,193 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class FirstEstimatedDeliveryDeleteTrackingByIdResponse
+
+    # The format of the EDD. Either a single date or a date range.
+    # type?: String;
+    attr_accessor :type
+
+    # The source of the EDD. Either the carrier, AfterShip AI, or based on your custom EDD settings.
+    # source?: String;
+    attr_accessor :source
+
+    # The latest EDD time.
+    # datetime?: String;
+    attr_accessor :datetime
+
+    # For a date range EDD format, the date and time for the lower end of the range.
+    # datetime_min?: String;
+    attr_accessor :datetime_min
+
+    # For a date range EDD format, the date and time for the upper end of the range.
+    # datetime_max?: String;
+    attr_accessor :datetime_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::FirstEstimatedDeliveryDeleteTrackingByIdResponse` initialize method"
+      end
+
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end 
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      end 
+
+      if attributes.key?(:'datetime')
+        self.datetime = attributes[:'datetime']
+      end 
+
+      if attributes.key?(:'datetime_min')
+        self.datetime_min = attributes[:'datetime_min']
+      end 
+
+      if attributes.key?(:'datetime_max')
+        self.datetime_max = attributes[:'datetime_max']
+      end 
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'source' => :'String',
+        :'datetime' => :'String',
+        :'datetime_min' => :'String',
+        :'datetime_max' => :'String',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'source' => :'source',
+        :'datetime' => :'datetime',
+        :'datetime_min' => :'datetime_min',
+        :'datetime_max' => :'datetime_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
+