aftership-tracking-sdk 8.0.0 → 10.0.0

data/lib/aftership-tracking-sdk/models/courier_estimated_delivery_date_update_tracking_by_id_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 CourierEstimatedDeliveryDateUpdateTrackingByIdResponse
+
+    # The estimated arrival date of the shipment. It reflects the shipment recipient’s timezone and the format may vary based on how the carrier provides it:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ
+    # estimated_delivery_date?: String;
+    attr_accessor :estimated_delivery_date
+
+    # The earliest estimated delivery date of the shipment. It reflects the shipment recipient’s timezone and the format may vary based on how the carrier provides it:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ
+    # estimated_delivery_date_min?: String;
+    attr_accessor :estimated_delivery_date_min
+
+    # The Latest estimated delivery date of the shipment. It reflects the shipment recipient’s timezone and the format may vary based on how the carrier provides it:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ
+    # estimated_delivery_date_max?: String;
+    attr_accessor :estimated_delivery_date_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::CourierEstimatedDeliveryDateUpdateTrackingByIdResponse` initialize method"
+      end
+
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'estimated_delivery_date')
+        self.estimated_delivery_date = attributes[:'estimated_delivery_date']
+      end 
+
+      if attributes.key?(:'estimated_delivery_date_min')
+        self.estimated_delivery_date_min = attributes[:'estimated_delivery_date_min']
+      end 
+
+      if attributes.key?(:'estimated_delivery_date_max')
+        self.estimated_delivery_date_max = attributes[:'estimated_delivery_date_max']
+      end 
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'estimated_delivery_date' => :'String',
+        :'estimated_delivery_date_min' => :'String',
+        :'estimated_delivery_date_max' => :'String',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'estimated_delivery_date' => :'estimated_delivery_date',
+        :'estimated_delivery_date_min' => :'estimated_delivery_date_min',
+        :'estimated_delivery_date_max' => :'estimated_delivery_date_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/courier_response_v1.rb

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

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class CreateTrackingRequest
+
     # Tracking number of a shipment.Duplicated tracking numbers, tracking numbers with invalid tracking number format will not be accepted.We only accept tracking numbers with length from 4 to 100We currently support the following characters in a tracking number:- A - Z- 0 - 9- `-` (Hyphen)- . (Period)- _ (Underscore)- / (Slash)
     # tracking_number: String;
     attr_accessor :tracking_number
@@ -54,25 +55,13 @@ module AftershipAPI::Model
     # tracking_key?: String;
     attr_accessor :tracking_key
 
-    # Additional field required by some carriers to retrieve the tracking info. The date the shipment was sent, using the format YYYYMMDD. Refer to our article on  for more details.
+    # The date and time when the shipment is shipped by the merchant and ready for pickup by the carrier. The field supports the following formats:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZThe field serves two key purposes:- Calculate processing time metrics in the Order-to-delivery Analytics dashboard. To ensure accurate analytics, it's recommended to include timezone information when configuring this value- Required by certain carriers to retrieve tracking information as an additional tracking field.
     # tracking_ship_date?: String;
     attr_accessor :tracking_ship_date
 
-    # Email address(es) to receive email notifications. Accept either array. Supports up to 3 email addresses.
-    # emails?: String[];
-    attr_accessor :emails
-
-    # The phone number(s) to receive sms notifications.  Enter `+` andarea `code before` phone number. Accept either array. Supports up to 3 phone numbers.
-    # smses?: String[];
-    attr_accessor :smses
-
-    # Customer name of the tracking.
-    # customer_name?: String;
-    attr_accessor :customer_name
-
     # The  for more details.
-    # origin_country_iso3?: String;
-    attr_accessor :origin_country_iso3
+    # origin_country_region?: String;
+    attr_accessor :origin_country_region
 
     # The state of the sender’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
     # origin_state?: String;
@@ -91,8 +80,8 @@ module AftershipAPI::Model
     attr_accessor :origin_raw_location
 
     # The  for more details.
-    # destination_country_iso3?: String;
-    attr_accessor :destination_country_iso3
+    # destination_country_region?: String;
+    attr_accessor :destination_country_region
 
     # The state of the recipient’s address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc. Also the 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.
     # destination_state?: String;
@@ -138,17 +127,13 @@ module AftershipAPI::Model
     # courier_connection_id?: String;
     attr_accessor :courier_connection_id
 
-    # If a shipment has multiple carriers, you can use the next_couriers field to tell AfterShip who the second carrier is. This is useful if the first carrier does not send us this information. 
-    # next_couriers?: NextCouriersCreateTrackingRequest[];
-    attr_accessor :next_couriers
-
-    # (Legacy) Replaced by `origin_country_iso3`. 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?: String;
-    attr_accessor :tracking_origin_country
+    # (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_iso3`. 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?: String;
-    attr_accessor :tracking_destination_country
+    # (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;
@@ -166,6 +151,14 @@ module AftershipAPI::Model
     # shipping_method?: String;
     attr_accessor :shipping_method
 
+    # This field contains information about the last leg of the shipment, starting from the carrier who hands it over to the last-mile carrier, all the way to delivery. Once AfterShip detects that the shipment involves multiple legs and identifies the last-mile carrier, we will populate the last-mile carrier information in this object. Alternatively, the user can provide this information in this field to specify the last-mile carrier, which is helpful if AfterShip is unable to detect it automatically.
+    # last_mile?: LastMileCreateTrackingRequest;
+    attr_accessor :last_mile
+
+    # The field contains the customer information associated with the tracking. A maximum of three customer objects are allowed.
+    # customers?: CustomersCreateTrackingRequest[];
+    attr_accessor :customers
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -233,20 +226,8 @@ module AftershipAPI::Model
         self.tracking_ship_date = attributes[:'tracking_ship_date']
       end 
 
-      if attributes.key?(:'emails')
-        self.emails = attributes[:'emails']
-      end 
-
-      if attributes.key?(:'smses')
-        self.smses = attributes[:'smses']
-      end 
-
-      if attributes.key?(:'customer_name')
-        self.customer_name = attributes[:'customer_name']
-      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?(:'origin_state')
@@ -265,8 +246,8 @@ module AftershipAPI::Model
         self.origin_raw_location = attributes[:'origin_raw_location']
       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 
 
       if attributes.key?(:'destination_state')
@@ -313,16 +294,12 @@ module AftershipAPI::Model
         self.courier_connection_id = attributes[:'courier_connection_id']
       end 
 
-      if attributes.key?(:'next_couriers')
-        self.next_couriers = attributes[:'next_couriers']
-      end 
-
-      if attributes.key?(:'tracking_origin_country')
-        self.tracking_origin_country = attributes[:'tracking_origin_country']
+      if attributes.key?(:'tracking_origin_country_region')
+        self.tracking_origin_country_region = attributes[:'tracking_origin_country_region']
       end 
 
-      if attributes.key?(:'tracking_destination_country')
-        self.tracking_destination_country = attributes[:'tracking_destination_country']
+      if attributes.key?(:'tracking_destination_country_region')
+        self.tracking_destination_country_region = attributes[:'tracking_destination_country_region']
       end 
 
       if attributes.key?(:'tracking_postal_code')
@@ -340,6 +317,14 @@ module AftershipAPI::Model
       if attributes.key?(:'shipping_method')
         self.shipping_method = attributes[:'shipping_method']
       end 
+
+      if attributes.key?(:'last_mile')
+        self.last_mile = attributes[:'last_mile']
+      end 
+
+      if attributes.key?(:'customers')
+        self.customers = attributes[:'customers']
+      end 
     end
 
     # Attribute type mapping.
@@ -359,15 +344,12 @@ module AftershipAPI::Model
         :'tracking_account_number' => :'String',
         :'tracking_key' => :'String',
         :'tracking_ship_date' => :'String',
-        :'emails' => :'Array<String>',
-        :'smses' => :'Array<String>',
-        :'customer_name' => :'String',
-        :'origin_country_iso3' => :'String',
+        :'origin_country_region' => :'String',
         :'origin_state' => :'String',
         :'origin_city' => :'String',
         :'origin_postal_code' => :'String',
         :'origin_raw_location' => :'String',
-        :'destination_country_iso3' => :'String',
+        :'destination_country_region' => :'String',
         :'destination_state' => :'String',
         :'destination_city' => :'String',
         :'destination_postal_code' => :'String',
@@ -379,13 +361,14 @@ module AftershipAPI::Model
         :'shipment_type' => :'String',
         :'shipment_tags' => :'Array<String>',
         :'courier_connection_id' => :'String',
-        :'next_couriers' => :'Array<NextCouriersCreateTrackingRequest>',
-        :'tracking_origin_country' => :'String',
-        :'tracking_destination_country' => :'String',
+        :'tracking_origin_country_region' => :'String',
+        :'tracking_destination_country_region' => :'String',
         :'tracking_postal_code' => :'String',
         :'tracking_state' => :'String',
         :'location_id' => :'String',
         :'shipping_method' => :'String',
+        :'last_mile' => :'LastMileCreateTrackingRequest',
+        :'customers' => :'Array<CustomersCreateTrackingRequest>',
       }
     end
 
@@ -406,15 +389,12 @@ module AftershipAPI::Model
         :'tracking_account_number' => :'tracking_account_number',
         :'tracking_key' => :'tracking_key',
         :'tracking_ship_date' => :'tracking_ship_date',
-        :'emails' => :'emails',
-        :'smses' => :'smses',
-        :'customer_name' => :'customer_name',
-        :'origin_country_iso3' => :'origin_country_iso3',
+        :'origin_country_region' => :'origin_country_region',
         :'origin_state' => :'origin_state',
         :'origin_city' => :'origin_city',
         :'origin_postal_code' => :'origin_postal_code',
         :'origin_raw_location' => :'origin_raw_location',
-        :'destination_country_iso3' => :'destination_country_iso3',
+        :'destination_country_region' => :'destination_country_region',
         :'destination_state' => :'destination_state',
         :'destination_city' => :'destination_city',
         :'destination_postal_code' => :'destination_postal_code',
@@ -426,13 +406,14 @@ module AftershipAPI::Model
         :'shipment_type' => :'shipment_type',
         :'shipment_tags' => :'shipment_tags',
         :'courier_connection_id' => :'courier_connection_id',
-        :'next_couriers' => :'next_couriers',
-        :'tracking_origin_country' => :'tracking_origin_country',
-        :'tracking_destination_country' => :'tracking_destination_country',
+        :'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',
         :'location_id' => :'location_id',
         :'shipping_method' => :'shipping_method',
+        :'last_mile' => :'last_mile',
+        :'customers' => :'customers',
       }
     end
 
@@ -549,3 +530,4 @@ module AftershipAPI::Model
     end
   end
 end
+