aftership-tracking-sdk 9.0.0 → 11.0.0

data/lib/aftership-tracking-sdk/models/destination_address_predict_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 DestinationAddressPredictResponse
+
+    # The country/region of the destination location where the package will be delivered. Use 3 letters of ISO 3166-1 country code.
+    # country_region: String;
+    attr_accessor :country_region
+
+    # State, province, or the equivalent location of the destination address where the package will be delivered.Either `destination_address.state` or `destination_address.postal_code` is required.
+    # state?: String;
+    attr_accessor :state
+
+    # City of the destination address where the package will be delivered.
+    # city?: String;
+    attr_accessor :city
+
+    # Postal code of the destination address.Either `destination_address.state` or `destination_address.postal_code` is required.
+    # postal_code?: String;
+    attr_accessor :postal_code
+
+    # Raw location of the destination address. A raw address will help AI to identify the accurate location of the destination address.
+    # raw_location?: String;
+    attr_accessor :raw_location
+
+    # 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::DestinationAddressPredictResponse` initialize method"
+      end
+
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'country_region')
+        self.country_region = attributes[:'country_region']
+      end 
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end 
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end 
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end 
+
+      if attributes.key?(:'raw_location')
+        self.raw_location = attributes[:'raw_location']
+      end 
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'country_region' => :'String',
+        :'state' => :'String',
+        :'city' => :'String',
+        :'postal_code' => :'String',
+        :'raw_location' => :'String',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'country_region' => :'country_region',
+        :'state' => :'state',
+        :'city' => :'city',
+        :'postal_code' => :'postal_code',
+        :'raw_location' => :'raw_location',
+      }
+    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/detect_courier_request.rb

@@ -12,8 +12,8 @@ module AftershipAPI::Model
     attr_accessor :slug
 
     # The postal code of receiver's address. Required by some couriers. Refer to  for more details
-    # tracking_postal_code?: String;
-    attr_accessor :tracking_postal_code
+    # destination_postal_code?: String;
+    attr_accessor :destination_postal_code
 
     # Shipping date in `YYYYMMDD` format. Required by some couriers. Refer to  for more details
     # tracking_ship_date?: String;
@@ -27,29 +27,21 @@ module AftershipAPI::Model
     # tracking_key?: String;
     attr_accessor :tracking_key
 
-    # Origin Country/Region of the shipment for a specific courier. Required by some couriers.
-    # tracking_origin_country?: String;
-    attr_accessor :tracking_origin_country
-
-    # Destination Country/Region of the shipment for a specific courier. Required by some couriers. Refer to  for more details
-    # tracking_destination_country?: String;
-    attr_accessor :tracking_destination_country
-
     # State of the destination shipping address of the shipment. Required by some couriers.
-    # tracking_state?: String;
-    attr_accessor :tracking_state
+    # destination_state?: String;
+    attr_accessor :destination_state
 
     # Slug group is a group of slugs which belong to same courier. For example, when you inpit "fedex-group" as slug_group, AfterShip will detect the tracking with "fedex-uk", "fedex-fims", and other slugs which belong to "fedex". It cannot be used with slug at the same time. (
-    # slug_group?: SlugGroupV1;
+    # slug_group?: SlugGroup;
     attr_accessor :slug_group
 
     # Enter .
-    # origin_country_iso3?: String;
-    attr_accessor :origin_country_iso3
+    # origin_country_region?: String;
+    attr_accessor :origin_country_region
 
     # Enter .
-    # destination_country_iso3?: String;
-    attr_accessor :destination_country_iso3
+    # destination_country_region?: String;
+    attr_accessor :destination_country_region
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
@@ -70,8 +62,8 @@ module AftershipAPI::Model
         self.slug = attributes[:'slug']
       end 
 
-      if attributes.key?(:'tracking_postal_code')
-        self.tracking_postal_code = attributes[:'tracking_postal_code']
+      if attributes.key?(:'destination_postal_code')
+        self.destination_postal_code = attributes[:'destination_postal_code']
       end 
 
       if attributes.key?(:'tracking_ship_date')
@@ -86,28 +78,20 @@ module AftershipAPI::Model
         self.tracking_key = attributes[:'tracking_key']
       end 
 
-      if attributes.key?(:'tracking_origin_country')
-        self.tracking_origin_country = attributes[:'tracking_origin_country']
-      end 
-
-      if attributes.key?(:'tracking_destination_country')
-        self.tracking_destination_country = attributes[:'tracking_destination_country']
-      end 
-
-      if attributes.key?(:'tracking_state')
-        self.tracking_state = attributes[:'tracking_state']
+      if attributes.key?(:'destination_state')
+        self.destination_state = attributes[:'destination_state']
       end 
 
       if attributes.key?(:'slug_group')
         self.slug_group = attributes[:'slug_group']
       end 
 
-      if attributes.key?(:'origin_country_iso3')
-        self.origin_country_iso3 = attributes[:'origin_country_iso3']
+      if attributes.key?(:'origin_country_region')
+        self.origin_country_region = attributes[:'origin_country_region']
       end 
 
-      if attributes.key?(:'destination_country_iso3')
-        self.destination_country_iso3 = attributes[:'destination_country_iso3']
+      if attributes.key?(:'destination_country_region')
+        self.destination_country_region = attributes[:'destination_country_region']
       end 
     end
 
@@ -116,16 +100,14 @@ module AftershipAPI::Model
       {
         :'tracking_number' => :'String',
         :'slug' => :'Array<String>',
-        :'tracking_postal_code' => :'String',
+        :'destination_postal_code' => :'String',
         :'tracking_ship_date' => :'String',
         :'tracking_account_number' => :'String',
         :'tracking_key' => :'String',
-        :'tracking_origin_country' => :'String',
-        :'tracking_destination_country' => :'String',
-        :'tracking_state' => :'String',
-        :'slug_group' => :'SlugGroupV1',
-        :'origin_country_iso3' => :'String',
-        :'destination_country_iso3' => :'String',
+        :'destination_state' => :'String',
+        :'slug_group' => :'SlugGroup',
+        :'origin_country_region' => :'String',
+        :'destination_country_region' => :'String',
       }
     end
 
@@ -134,16 +116,14 @@ module AftershipAPI::Model
       {
         :'tracking_number' => :'tracking_number',
         :'slug' => :'slug',
-        :'tracking_postal_code' => :'tracking_postal_code',
+        :'destination_postal_code' => :'destination_postal_code',
         :'tracking_ship_date' => :'tracking_ship_date',
         :'tracking_account_number' => :'tracking_account_number',
         :'tracking_key' => :'tracking_key',
-        :'tracking_origin_country' => :'tracking_origin_country',
-        :'tracking_destination_country' => :'tracking_destination_country',
-        :'tracking_state' => :'tracking_state',
+        :'destination_state' => :'destination_state',
         :'slug_group' => :'slug_group',
-        :'origin_country_iso3' => :'origin_country_iso3',
-        :'destination_country_iso3' => :'destination_country_iso3',
+        :'origin_country_region' => :'origin_country_region',
+        :'destination_country_region' => :'destination_country_region',
       }
     end
 

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

@@ -0,0 +1,183 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class EstimatedPickupPredictRequest
+
+    # The local order time in the origin address time zone of the package.
+    # order_time: String;
+    attr_accessor :order_time
+
+    # Order cut off time in the origin address time zone. The default value set by AfterShip is 18:00:00.
+    # order_cutoff_time?: String;
+    attr_accessor :order_cutoff_time
+
+    # Operating days in a week. Number refers to the weekday.E.g., [1,2,3,4,5] means operating days are from Monday to Friday.AfterShip will set [1,2,3,4,5] as the default value.
+    # business_days?: Integer[];
+    attr_accessor :business_days
+
+    # 
+    # order_processing_time?: OrderProcessingTimeEstimatedPickupPredictRequest;
+    attr_accessor :order_processing_time
+
+    # 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::EstimatedPickupPredictRequest` initialize method"
+      end
+
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'order_time')
+        self.order_time = attributes[:'order_time']
+      end 
+
+      if attributes.key?(:'order_cutoff_time')
+        self.order_cutoff_time = attributes[:'order_cutoff_time']
+      end 
+
+      if attributes.key?(:'business_days')
+        self.business_days = attributes[:'business_days']
+      end 
+
+      if attributes.key?(:'order_processing_time')
+        self.order_processing_time = attributes[:'order_processing_time']
+      end 
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'order_time' => :'String',
+        :'order_cutoff_time' => :'String',
+        :'business_days' => :'Array<Integer>',
+        :'order_processing_time' => :'OrderProcessingTimeEstimatedPickupPredictRequest',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'order_time' => :'order_time',
+        :'order_cutoff_time' => :'order_cutoff_time',
+        :'business_days' => :'business_days',
+        :'order_processing_time' => :'order_processing_time',
+      }
+    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
+