aftership-tracking-sdk 7.0.0 → 9.0.0

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

@@ -0,0 +1,163 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class ShipmentWeightUpdateTrackingByIdResponse
+
+    # The unit in which the value field is expressed.
+    # unit?: String;
+    attr_accessor :unit
+
+    # The total amount of shipment weight.
+    # value?: Float;
+    attr_accessor :value
+
+    # 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::ShipmentWeightUpdateTrackingByIdResponse` initialize method"
+      end
+
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'unit')
+        self.unit = attributes[:'unit']
+      end 
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      end 
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'unit' => :'String',
+        :'value' => :'Float',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'unit' => :'unit',
+        :'value' => :'value',
+      }
+    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/slug_group_v1.rb

@@ -16,7 +16,7 @@ module AftershipAPI::Model
     FASTWAY_GROUP = "fastway-group".freeze
     ASENDIA_GROUP = "asendia-group".freeze
     def self.all_vars
-      @all_vars ||= [AMAZON_GROUP, FEDEX_GROUP, TOLL_GROUP, TAQBIN_GROUP, TNT_GROUP, CJ_GROUP, HERMES_GROUP, DPD_GROUP, GLS_GROUP, DHL_GROUP, FASTWAY_GROUP, ASENDIA_GROUP,].freeze
+      @all_vars ||= [AMAZON_GROUP,FEDEX_GROUP,TOLL_GROUP,TAQBIN_GROUP,TNT_GROUP,CJ_GROUP,HERMES_GROUP,DPD_GROUP,GLS_GROUP,DHL_GROUP,FASTWAY_GROUP,ASENDIA_GROUP,].freeze
     end
 
     # Builds the enum from string

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

@@ -13,7 +13,7 @@ module AftershipAPI::Model
     EXCEPTION = "Exception".freeze
     EXPIRED = "Expired".freeze
     def self.all_vars
-      @all_vars ||= [PENDING, INFORECEIVED, INTRANSIT, OUTFORDELIVERY, ATTEMPTFAIL, DELIVERED, AVAILABLEFORPICKUP, EXCEPTION, EXPIRED,].freeze
+      @all_vars ||= [PENDING,INFORECEIVED,INTRANSIT,OUTFORDELIVERY,ATTEMPTFAIL,DELIVERED,AVAILABLEFORPICKUP,EXCEPTION,EXPIRED,].freeze
     end
 
     # Builds the enum from string

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

@@ -2,10 +2,15 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class Tracking
+
     # Tracking ID.
     # id?: String;
     attr_accessor :id
 
+    # The length of the tracking ID has been increased from 24 characters to 32 characters. We will use the legacy_id field to store the original 24-character tracking ID to maintain compatibility with existing data. Therefore, all tracking endpoints will continue to work with the legacy_id field as before.
+    # legacy_id?: String;
+    attr_accessor :legacy_id
+
     # The date and time the shipment was imported or added to AfterShip. It uses the format `YYYY-MM-DDTHH:mm:ssZ` for the timezone GMT +0.
     # created_at?: String;
     attr_accessor :created_at
@@ -90,9 +95,9 @@ module AftershipAPI::Model
     # emails?: String[];
     attr_accessor :emails
 
-    # The estimated delivery date provided by the carrier. It uses the shipment recipient’s timezone and the format may differ depending on how the carrier provides it:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ
-    # expected_delivery?: String;
-    attr_accessor :expected_delivery
+    # The field contains the estimated delivery date provided by the carrier.
+    # courier_estimated_delivery_date?: CourierEstimatedDeliveryDateTracking;
+    attr_accessor :courier_estimated_delivery_date
 
     # Text field for the note.
     # note?: String;
@@ -126,19 +131,15 @@ module AftershipAPI::Model
     # shipment_type?: String;
     attr_accessor :shipment_type
 
-    # Shipment weight provied by carrier.
-    # shipment_weight?: Float;
+    # The shipment_weight field represents the total weight of the shipment. In scenarios where the carrier does not provide this information, you can provide the weight to AfterShip. We will prioritize the data provided by the carrier, if available. The shipment weight will be included in the Response and accessed through the GET API, Webhook, and CSV export. It will also be displayed on the AfterShip Tracking admin. Additionally, it plays a significant role in error-free shipment handling and carbon emission calculations, ensuring accurate and informed decision-making
+    # shipment_weight?: ShipmentWeightTracking;
     attr_accessor :shipment_weight
 
-    # Weight unit provied by carrier.
-    # shipment_weight_unit?: String;
-    attr_accessor :shipment_weight_unit
-
     # Signed by information for delivered shipment.
     # signed_by?: String;
     attr_accessor :signed_by
 
-    # The phone number(s) to receive sms notifications.  Phone number should begin with `+` and `Area Code` before phone number. Comma separated for multiple values.
+    # The phone number(s) to receive sms notifications.  Phone number should begin with `+` and `Area Code` before phone number.
     # smses?: String[];
     attr_accessor :smses
 
@@ -182,11 +183,11 @@ module AftershipAPI::Model
     # checkpoints?: Checkpoint[];
     attr_accessor :checkpoints
 
-    # Phone number(s) subscribed to receive sms notifications. Comma separated for multiple values
+    # Phone number(s) subscribed to receive sms notifications.
     # subscribed_smses?: String[];
     attr_accessor :subscribed_smses
 
-    # Email address(es) subscribed to receive email notifications. Comma separated for multiple values
+    # Email address(es) subscribed to receive email notifications.
     # subscribed_emails?: String[];
     attr_accessor :subscribed_emails
 
@@ -194,7 +195,7 @@ module AftershipAPI::Model
     # return_to_sender?: Boolean;
     attr_accessor :return_to_sender
 
-    # The promised delivery date of the order. It uses the format `YYYY-MM-DD`. This has no timezone and uses whatever date you provide.
+    # The promised delivery date of the order. It uses the formats:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ
     # order_promised_delivery_date?: String;
     attr_accessor :order_promised_delivery_date
 
@@ -314,6 +315,18 @@ module AftershipAPI::Model
     # signature_requirement?: String;
     attr_accessor :signature_requirement
 
+    # The delivery location type represents the secure area where the carrier leaves the package, such as a safe place, locker, mailbox, front porch, etc. This information helps ensure the shipment reaches the intended recipient efficiently, minimizing the risk of theft or damage.
+    # delivery_location_type?: String;
+    attr_accessor :delivery_location_type
+
+    # The tracking URL directs your customers to the shipment tracking page which can display either the default or a customized page based on segmentation rules.- The universal URL is used by default, but you can opt for a custom domain if you have one. Learn how to set up a custom domain .The field is not automatically enabled in API & Webhook. Please contact support if you’d like to enable it.
+    # aftership_tracking_url?: String;
+    attr_accessor :aftership_tracking_url
+
+    # The order URL directs your customers to the order tracking page, which includes all shipments. It can display either the default or a customized page based on segmentation rules.- The universal URL is used by default, but you can opt for a custom domain if you have one. Learn how to set up a custom domain .The field is not automatically enabled in API & Webhook. Please contact support if you’d like to enable it.
+    # aftership_tracking_order_url?: String;
+    attr_accessor :aftership_tracking_order_url
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -329,6 +342,10 @@ module AftershipAPI::Model
         self.id = attributes[:'id']
       end 
 
+      if attributes.key?(:'legacy_id')
+        self.legacy_id = attributes[:'legacy_id']
+      end 
+
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end 
@@ -413,8 +430,8 @@ module AftershipAPI::Model
         self.emails = attributes[:'emails']
       end 
 
-      if attributes.key?(:'expected_delivery')
-        self.expected_delivery = attributes[:'expected_delivery']
+      if attributes.key?(:'courier_estimated_delivery_date')
+        self.courier_estimated_delivery_date = attributes[:'courier_estimated_delivery_date']
       end 
 
       if attributes.key?(:'note')
@@ -453,10 +470,6 @@ module AftershipAPI::Model
         self.shipment_weight = attributes[:'shipment_weight']
       end 
 
-      if attributes.key?(:'shipment_weight_unit')
-        self.shipment_weight_unit = attributes[:'shipment_weight_unit']
-      end 
-
       if attributes.key?(:'signed_by')
         self.signed_by = attributes[:'signed_by']
       end 
@@ -636,12 +649,25 @@ module AftershipAPI::Model
       if attributes.key?(:'signature_requirement')
         self.signature_requirement = attributes[:'signature_requirement']
       end 
+
+      if attributes.key?(:'delivery_location_type')
+        self.delivery_location_type = attributes[:'delivery_location_type']
+      end 
+
+      if attributes.key?(:'aftership_tracking_url')
+        self.aftership_tracking_url = attributes[:'aftership_tracking_url']
+      end 
+
+      if attributes.key?(:'aftership_tracking_order_url')
+        self.aftership_tracking_order_url = attributes[:'aftership_tracking_order_url']
+      end 
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
         :'id' => :'String',
+        :'legacy_id' => :'String',
         :'created_at' => :'String',
         :'updated_at' => :'String',
         :'last_updated_at' => :'String',
@@ -663,7 +689,7 @@ module AftershipAPI::Model
         :'destination_raw_location' => :'String',
         :'courier_destination_country_iso3' => :'String',
         :'emails' => :'Array<String>',
-        :'expected_delivery' => :'String',
+        :'courier_estimated_delivery_date' => :'CourierEstimatedDeliveryDateTracking',
         :'note' => :'String',
         :'order_id' => :'String',
         :'order_id_path' => :'String',
@@ -672,8 +698,7 @@ module AftershipAPI::Model
         :'shipment_pickup_date' => :'String',
         :'shipment_delivery_date' => :'String',
         :'shipment_type' => :'String',
-        :'shipment_weight' => :'Float',
-        :'shipment_weight_unit' => :'String',
+        :'shipment_weight' => :'ShipmentWeightTracking',
         :'signed_by' => :'String',
         :'smses' => :'Array<String>',
         :'source' => :'String',
@@ -719,6 +744,9 @@ module AftershipAPI::Model
         :'shipping_method' => :'String',
         :'failed_delivery_attempts' => :'Integer',
         :'signature_requirement' => :'String',
+        :'delivery_location_type' => :'String',
+        :'aftership_tracking_url' => :'String',
+        :'aftership_tracking_order_url' => :'String',
       }
     end
 
@@ -726,6 +754,7 @@ module AftershipAPI::Model
     def self.attribute_map
       {
         :'id' => :'id',
+        :'legacy_id' => :'legacy_id',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at',
         :'last_updated_at' => :'last_updated_at',
@@ -747,7 +776,7 @@ module AftershipAPI::Model
         :'destination_raw_location' => :'destination_raw_location',
         :'courier_destination_country_iso3' => :'courier_destination_country_iso3',
         :'emails' => :'emails',
-        :'expected_delivery' => :'expected_delivery',
+        :'courier_estimated_delivery_date' => :'courier_estimated_delivery_date',
         :'note' => :'note',
         :'order_id' => :'order_id',
         :'order_id_path' => :'order_id_path',
@@ -757,7 +786,6 @@ module AftershipAPI::Model
         :'shipment_delivery_date' => :'shipment_delivery_date',
         :'shipment_type' => :'shipment_type',
         :'shipment_weight' => :'shipment_weight',
-        :'shipment_weight_unit' => :'shipment_weight_unit',
         :'signed_by' => :'signed_by',
         :'smses' => :'smses',
         :'source' => :'source',
@@ -803,6 +831,9 @@ module AftershipAPI::Model
         :'shipping_method' => :'shipping_method',
         :'failed_delivery_attempts' => :'failed_delivery_attempts',
         :'signature_requirement' => :'signature_requirement',
+        :'delivery_location_type' => :'delivery_location_type',
+        :'aftership_tracking_url' => :'aftership_tracking_url',
+        :'aftership_tracking_order_url' => :'aftership_tracking_order_url',
       }
     end
 
@@ -919,3 +950,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class TrackingResponseGetMultipleV1
+
     # Meta data
     # meta: MetaV1;
     attr_accessor :meta
@@ -159,3 +160,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,12 +2,13 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class TrackingResponseV1
+
     # Meta data
     # meta: MetaV1;
     attr_accessor :meta
 
-    # 
-    # data: DataTrackingResponseV1;
+    # Object describes the tracking information.<div style="display:none; height: 0"></div>
+    # data: Tracking;
     attr_accessor :data
 
     # Initializes the object
@@ -34,7 +35,7 @@ module AftershipAPI::Model
     def self.openapi_types
       {
         :'meta' => :'MetaV1',
-        :'data' => :'DataTrackingResponseV1',
+        :'data' => :'Tracking',
       }
     end
 
@@ -159,3 +160,4 @@ module AftershipAPI::Model
     end
   end
 end
+

data/lib/aftership-tracking-sdk/models/{tracking_update_tracking_by_id_request.rb → update_tracking_by_id_request.rb}

@@ -1,7 +1,8 @@
 # This code was auto generated by AfterShip SDK Generator.
 # Do not edit the class manually.
 module AftershipAPI::Model
-  class TrackingUpdateTrackingByIdRequest
+  class UpdateTrackingByIdRequest
+
     # The phone number(s) to receive sms notifications.  Input `[]` to clear the value of this field. Supports up to 3 phone numbers.
     # smses?: String[];
     attr_accessor :smses
@@ -38,7 +39,7 @@ module AftershipAPI::Model
     # language?: String;
     attr_accessor :language
 
-    # The promised delivery date of the order. It uses the format YYYY-MM-DD. This has no timezone and uses whatever date you provide. Since other EDDs use the shipment recipient’s timezone, we suggest following the same logic here.
+    # The promised delivery date of the order. It uses the formats:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ
     # order_promised_delivery_date?: String;
     attr_accessor :order_promised_delivery_date
 
@@ -150,7 +151,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::TrackingUpdateTrackingByIdRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::UpdateTrackingByIdRequest` initialize method"
       end
 
       attributes = attributes.each_with_object({}) { |(k, v), h|
@@ -499,3 +500,4 @@ module AftershipAPI::Model
     end
   end
 end
+