aftership-tracking-sdk 10.0.0 → 11.0.0

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

@@ -23,6 +23,10 @@ module AftershipAPI::Model
     # datetime_max?: String;
     attr_accessor :datetime_max
 
+    # Explains the reason for a change to the latest_estimated_delivery. This string will only have a value if:1. The source for the latest EDD is AfterShip EDD. 2. The reason for the change is known.For a comprehensive list of reasons, please refer to this document.
+    # revise_reason?: String;
+    attr_accessor :revise_reason
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -53,6 +57,10 @@ module AftershipAPI::Model
       if attributes.key?(:'datetime_max')
         self.datetime_max = attributes[:'datetime_max']
       end 
+
+      if attributes.key?(:'revise_reason')
+        self.revise_reason = attributes[:'revise_reason']
+      end 
     end
 
     # Attribute type mapping.
@@ -63,6 +71,7 @@ module AftershipAPI::Model
         :'datetime' => :'String',
         :'datetime_min' => :'String',
         :'datetime_max' => :'String',
+        :'revise_reason' => :'String',
       }
     end
 
@@ -74,6 +83,7 @@ module AftershipAPI::Model
         :'datetime' => :'datetime',
         :'datetime_min' => :'datetime_min',
         :'datetime_max' => :'datetime_max',
+        :'revise_reason' => :'revise_reason',
       }
     end
 

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

@@ -7,6 +7,10 @@ module AftershipAPI::Model
     # reason: String;
     attr_accessor :reason
 
+    # The actual occurrence time of the marked tracking status.The field supports the following formats: - YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ
+    # event_datetime?: String;
+    attr_accessor :event_datetime
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -21,12 +25,17 @@ module AftershipAPI::Model
       if attributes.key?(:'reason')
         self.reason = attributes[:'reason']
       end 
+
+      if attributes.key?(:'event_datetime')
+        self.event_datetime = attributes[:'event_datetime']
+      end 
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
         :'reason' => :'String',
+        :'event_datetime' => :'String',
       }
     end
 
@@ -34,6 +43,7 @@ module AftershipAPI::Model
     def self.attribute_map
       {
         :'reason' => :'reason',
+        :'event_datetime' => :'event_datetime',
       }
     end
 

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

@@ -3,7 +3,7 @@
 module AftershipAPI::Model
   class MarkTrackingCompletedByIdResponse
 
-    # Tracking ID.
+    # A  system-generated tracking ID by default, which can be customized by the user when creating a tracking.
     # id?: String;
     attr_accessor :id
 
@@ -27,7 +27,7 @@ module AftershipAPI::Model
     # slug?: String;
     attr_accessor :slug
 
-    # Whether or not AfterShip will continue tracking the shipments. Value is `false` when tag (status) is `Delivered`, `Expired`, or further updates for 30 days since last update.
+    # Whether or not AfterShip will continue tracking the shipment. Value is false when no further updates for a few days since last update.
     # active?: Boolean;
     attr_accessor :active
 
@@ -132,7 +132,7 @@ module AftershipAPI::Model
     attr_accessor :source
 
     # Current status of tracking. (
-    # tag?: TagV1;
+    # tag?: Tag;
     attr_accessor :tag
 
     # Current subtag of tracking. (
@@ -259,22 +259,6 @@ module AftershipAPI::Model
     # courier_connection_id?: String;
     attr_accessor :courier_connection_id
 
-    # (Legacy) Replaced by `origin_country_region`. Additional field required by some carriers to retrieve the tracking info. The origin country/region of the shipment. Refer to our article on  for more details.
-    # tracking_origin_country_region?: String;
-    attr_accessor :tracking_origin_country_region
-
-    # (Legacy) Replaced by `destination_country_region`. Additional field required by some carriers to retrieve the tracking info. The destination country/region of the shipment. Refer to our article on  for more details.
-    # tracking_destination_country_region?: String;
-    attr_accessor :tracking_destination_country_region
-
-    # (Legacy) Replaced by `destination_postal_code`. Additional field required by some carriers to retrieve the tracking info. The postal code of the recipient’s address. Refer to our article on  for more details.
-    # tracking_postal_code?: String;
-    attr_accessor :tracking_postal_code
-
-    # (Legacy) Replaced by `destination_state`. Additional field required by some carriers to retrieve the tracking info. The state/province of the recipient’s address. Refer to our article on  for more details.
-    # tracking_state?: String;
-    attr_accessor :tracking_state
-
     # The model contains the total amount of carbon emissions generated by the shipment. - AfterShip will provide this data only when it is available, and its availability is contingent upon the location and weight information that AfterShip can obtain.- The values will be accessible solely for shipments that have been successfully delivered. However, in the event of a shipping update after the delivery status has been achieved, the value may change.- It’s a paid service and only for Tracking Enterprise users, please contact your customer success manager if you want to know more.
     # carbon_emissions?: CarbonEmissionsMarkTrackingCompletedByIdResponse;
     attr_accessor :carbon_emissions
@@ -586,22 +570,6 @@ module AftershipAPI::Model
         self.courier_connection_id = attributes[:'courier_connection_id']
       end 
 
-      if attributes.key?(:'tracking_origin_country_region')
-        self.tracking_origin_country_region = attributes[:'tracking_origin_country_region']
-      end 
-
-      if attributes.key?(:'tracking_destination_country_region')
-        self.tracking_destination_country_region = attributes[:'tracking_destination_country_region']
-      end 
-
-      if attributes.key?(:'tracking_postal_code')
-        self.tracking_postal_code = attributes[:'tracking_postal_code']
-      end 
-
-      if attributes.key?(:'tracking_state')
-        self.tracking_state = attributes[:'tracking_state']
-      end 
-
       if attributes.key?(:'carbon_emissions')
         self.carbon_emissions = attributes[:'carbon_emissions']
       end 
@@ -682,7 +650,7 @@ module AftershipAPI::Model
         :'shipment_weight' => :'ShipmentWeightMarkTrackingCompletedByIdResponse',
         :'signed_by' => :'String',
         :'source' => :'String',
-        :'tag' => :'TagV1',
+        :'tag' => :'Tag',
         :'subtag' => :'String',
         :'subtag_message' => :'String',
         :'title' => :'String',
@@ -714,10 +682,6 @@ module AftershipAPI::Model
         :'latest_estimated_delivery' => :'LatestEstimatedDeliveryMarkTrackingCompletedByIdResponse',
         :'shipment_tags' => :'Array<String>',
         :'courier_connection_id' => :'String',
-        :'tracking_origin_country_region' => :'String',
-        :'tracking_destination_country_region' => :'String',
-        :'tracking_postal_code' => :'String',
-        :'tracking_state' => :'String',
         :'carbon_emissions' => :'CarbonEmissionsMarkTrackingCompletedByIdResponse',
         :'location_id' => :'String',
         :'shipping_method' => :'String',
@@ -799,10 +763,6 @@ module AftershipAPI::Model
         :'latest_estimated_delivery' => :'latest_estimated_delivery',
         :'shipment_tags' => :'shipment_tags',
         :'courier_connection_id' => :'courier_connection_id',
-        :'tracking_origin_country_region' => :'tracking_origin_country_region',
-        :'tracking_destination_country_region' => :'tracking_destination_country_region',
-        :'tracking_postal_code' => :'tracking_postal_code',
-        :'tracking_state' => :'tracking_state',
         :'carbon_emissions' => :'carbon_emissions',
         :'location_id' => :'location_id',
         :'shipping_method' => :'shipping_method',

data/lib/aftership-tracking-sdk/models/{meta_v1.rb → meta.rb}

@@ -1,7 +1,7 @@
 # This code was auto generated by AfterShip SDK Generator.
 # Do not edit the class manually.
 module AftershipAPI::Model
-  class MetaV1
+  class Meta
 
     # meta code
     # code: Integer;
@@ -19,7 +19,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::MetaV1` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::Meta` initialize method"
       end
 
       attributes = attributes.each_with_object({}) { |(k, v), h|

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

@@ -0,0 +1,173 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class PaginationDataCourierConnectionResponseForGetCourierConnections
+
+    # The total number of courier connections.
+    # total?: Integer;
+    attr_accessor :total
+
+    # A string representing the cursor value for the next page of results.
+    # next_cursor?: String;
+    attr_accessor :next_cursor
+
+    # To indicate if next page is available.
+    # has_next_page?: Boolean;
+    attr_accessor :has_next_page
+
+    # 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::PaginationDataCourierConnectionResponseForGetCourierConnections` initialize method"
+      end
+
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      end 
+
+      if attributes.key?(:'next_cursor')
+        self.next_cursor = attributes[:'next_cursor']
+      end 
+
+      if attributes.key?(:'has_next_page')
+        self.has_next_page = attributes[:'has_next_page']
+      end 
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'total' => :'Integer',
+        :'next_cursor' => :'String',
+        :'has_next_page' => :'Boolean',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'total' => :'total',
+        :'next_cursor' => :'next_cursor',
+        :'has_next_page' => :'has_next_page',
+      }
+    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/{pagination_data_tracking_response_get_multiple_v1.rb → pagination_data_tracking_response_for_get_trackings.rb}

@@ -1,7 +1,7 @@
 # This code was auto generated by AfterShip SDK Generator.
 # Do not edit the class manually.
 module AftershipAPI::Model
-  class PaginationDataTrackingResponseGetMultipleV1
+  class PaginationDataTrackingResponseForGetTrackings
 
     # The total number of trackings.
     # total?: Integer;
@@ -19,7 +19,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::PaginationDataTrackingResponseGetMultipleV1` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::PaginationDataTrackingResponseForGetTrackings` initialize method"
       end
 
       attributes = attributes.each_with_object({}) { |(k, v), h|

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

@@ -0,0 +1,173 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class PaginationGetCourierConnectionsResponse
+
+    # The total number of courier connections.
+    # total?: Integer;
+    attr_accessor :total
+
+    # A string representing the cursor value for the next page of results.
+    # next_cursor?: String;
+    attr_accessor :next_cursor
+
+    # To indicate if next page is available.
+    # has_next_page?: Boolean;
+    attr_accessor :has_next_page
+
+    # 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::PaginationGetCourierConnectionsResponse` initialize method"
+      end
+
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      end 
+
+      if attributes.key?(:'next_cursor')
+        self.next_cursor = attributes[:'next_cursor']
+      end 
+
+      if attributes.key?(:'has_next_page')
+        self.has_next_page = attributes[:'has_next_page']
+      end 
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'total' => :'Integer',
+        :'next_cursor' => :'String',
+        :'has_next_page' => :'Boolean',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'total' => :'total',
+        :'next_cursor' => :'next_cursor',
+        :'has_next_page' => :'has_next_page',
+      }
+    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
+