aftership-tracking-sdk 14.0.0 → 15.0.0

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

@@ -0,0 +1,151 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class TrackingForwardShipment
+    # AfterShip system-assigned unique identifier of the linked outbound shipment.
+    # id?: String;
+    attr_accessor :id
+
+    # 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::TrackingForwardShipment` initialize method"
+      end
+
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+      }
+    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/tracking_multi_piece_info.rb

@@ -0,0 +1,161 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class TrackingMultiPieceInfo
+    # Indicates the role of the current tracking object within the multi-piece shipment.Possible values:- `master`: The main tracking number representing the entire shipment. It may not always exist.- `child`: A sub-tracking number belonging to one of the pieces in the shipment.
+    # type?: TrackingMultiPieceInfoType;
+    attr_accessor :type
+
+    # List of all pieces in the MPS, including the master and all child pieces.
+    # pieces?: TrackingMultiPieceInfoPieces[];
+    attr_accessor :pieces
+
+    # 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::TrackingMultiPieceInfo` 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?(:'pieces')
+        self.pieces = attributes[:'pieces']
+      end
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'TrackingMultiPieceInfoType',
+        :'pieces' => :'Array<TrackingMultiPieceInfoPieces>',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'pieces' => :'pieces',
+      }
+    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/tracking_multi_piece_info_pieces.rb

@@ -0,0 +1,181 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class TrackingMultiPieceInfoPieces
+    # AfterShip system-assigned unique identifier for the piece.
+    # tracking_id?: String;
+    attr_accessor :tracking_id
+
+    # Carrier-assigned tracking number for the piece.
+    # tracking_number?: String;
+    attr_accessor :tracking_number
+
+    # Type of the piece within the MPS: `master` or `child`.
+    # type?: TrackingMultiPieceInfoPiecesType;
+    attr_accessor :type
+
+    # Indicates whether the tracking number can be used to retrieve tracking updates on the carrier's side. If not, it means the carrier can only return a child tracking number, but cannot independently provide tracking updates for the sub-shipment. In this case, it is not recommended for you to import this tracking number into AfterShip for tracking.
+    # trackable?: Boolean;
+    attr_accessor :trackable
+
+    # 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::TrackingMultiPieceInfoPieces` initialize method"
+      end
+
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'tracking_id')
+        self.tracking_id = attributes[:'tracking_id']
+      end
+
+      if attributes.key?(:'tracking_number')
+        self.tracking_number = attributes[:'tracking_number']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'trackable')
+        self.trackable = attributes[:'trackable']
+      end
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'tracking_id' => :'String',
+        :'tracking_number' => :'String',
+        :'type' => :'TrackingMultiPieceInfoPiecesType',
+        :'trackable' => :'Boolean',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'tracking_id' => :'tracking_id',
+        :'tracking_number' => :'tracking_number',
+        :'type' => :'type',
+        :'trackable' => :'trackable',
+      }
+    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/tracking_multi_piece_info_pieces_type.rb

@@ -0,0 +1,26 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class TrackingMultiPieceInfoPiecesType
+    MASTER = "master".freeze
+    CHILD = "child".freeze
+    def self.all_vars
+      @all_vars ||= [MASTER, CHILD,].freeze
+    end
+
+    # Builds the enum from string
+    # @param value [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param value [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if TrackingMultiPieceInfoPiecesType.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #TrackingMultiPieceInfoPiecesType"
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class TrackingMultiPieceInfoType
+    MASTER = "master".freeze
+    CHILD = "child".freeze
+    def self.all_vars
+      @all_vars ||= [MASTER, CHILD,].freeze
+    end
+
+    # Builds the enum from string
+    # @param value [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param value [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if TrackingMultiPieceInfoType.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #TrackingMultiPieceInfoType"
+    end
+  end
+end

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

@@ -0,0 +1,161 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class TrackingProofOfDelivery
+    # The file type of the proof of delivery record. Currently, only images are supported.
+    # type?: String;
+    attr_accessor :type
+
+    # The URL of the proof of delivery record.
+    # url?: String;
+    attr_accessor :url
+
+    # 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::TrackingProofOfDelivery` 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?(:'url')
+        self.url = attributes[:'url']
+      end
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'url' => :'String',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'url' => :'url',
+      }
+    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