aftership-tracking-sdk 10.0.0 → 11.0.0

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

@@ -3,7 +3,7 @@
 module AftershipAPI::Model
   class DeleteTrackingByIdResponse
 
-    # 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?: CarbonEmissionsDeleteTrackingByIdResponse;
     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' => :'ShipmentWeightDeleteTrackingByIdResponse',
         :'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' => :'LatestEstimatedDeliveryDeleteTrackingByIdResponse',
         :'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' => :'CarbonEmissionsDeleteTrackingByIdResponse',
         :'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/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,20 +27,12 @@ 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_region?: String;
-    attr_accessor :tracking_origin_country_region
-
-    # Destination Country/Region of the shipment for a specific courier. Required by some couriers. Refer to  for more details
-    # tracking_destination_country_region?: String;
-    attr_accessor :tracking_destination_country_region
-
     # 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 .
@@ -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,16 +78,8 @@ module AftershipAPI::Model
         self.tracking_key = attributes[:'tracking_key']
       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_state')
-        self.tracking_state = attributes[:'tracking_state']
+      if attributes.key?(:'destination_state')
+        self.destination_state = attributes[:'destination_state']
       end 
 
       if attributes.key?(:'slug_group')
@@ -116,14 +100,12 @@ 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_region' => :'String',
-        :'tracking_destination_country_region' => :'String',
-        :'tracking_state' => :'String',
-        :'slug_group' => :'SlugGroupV1',
+        :'destination_state' => :'String',
+        :'slug_group' => :'SlugGroup',
         :'origin_country_region' => :'String',
         :'destination_country_region' => :'String',
       }
@@ -134,13 +116,11 @@ 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_region' => :'tracking_origin_country_region',
-        :'tracking_destination_country_region' => :'tracking_destination_country_region',
-        :'tracking_state' => :'tracking_state',
+        :'destination_state' => :'destination_state',
         :'slug_group' => :'slug_group',
         :'origin_country_region' => :'origin_country_region',
         :'destination_country_region' => :'destination_country_region',

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

@@ -12,7 +12,7 @@ module AftershipAPI::Model
     attr_accessor :slug
 
     # The transit time for the first-mile of a shipment in days. This field is calculated based on whether the handed_over_to_last_mile_carrier or received_by_last_mile_carrier event is detected by AfterShip. The handover event date is used to calculate the first-mile transit time.- First mile transit time (in days) = Handover date - Pickup date 
-    # transit_time?: String;
+    # transit_time?: Integer;
     attr_accessor :transit_time
 
     # The field provides the link for modifying delivery instructions (such as delivery date and shipping address), if supported by the first-mile carrier. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the destination country/region and language data is unavailable, AfterShip will default the language parameter to "US".
@@ -60,7 +60,7 @@ module AftershipAPI::Model
       {
         :'tracking_number' => :'String',
         :'slug' => :'String',
-        :'transit_time' => :'String',
+        :'transit_time' => :'Integer',
         :'courier_redirect_link' => :'String',
         :'courier_tracking_link' => :'String',
       }

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

@@ -12,7 +12,7 @@ module AftershipAPI::Model
     attr_accessor :slug
 
     # The transit time for the first-mile of a shipment in days. This field is calculated based on whether the handed_over_to_last_mile_carrier or received_by_last_mile_carrier event is detected by AfterShip. The handover event date is used to calculate the first-mile transit time.- First mile transit time (in days) = Handover date - Pickup date 
-    # transit_time?: String;
+    # transit_time?: Integer;
     attr_accessor :transit_time
 
     # The field provides the link for modifying delivery instructions (such as delivery date and shipping address), if supported by the first-mile carrier. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the destination country/region and language data is unavailable, AfterShip will default the language parameter to "US".
@@ -60,7 +60,7 @@ module AftershipAPI::Model
       {
         :'tracking_number' => :'String',
         :'slug' => :'String',
-        :'transit_time' => :'String',
+        :'transit_time' => :'Integer',
         :'courier_redirect_link' => :'String',
         :'courier_tracking_link' => :'String',
       }

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

@@ -12,7 +12,7 @@ module AftershipAPI::Model
     attr_accessor :slug
 
     # The transit time for the first-mile of a shipment in days. This field is calculated based on whether the handed_over_to_last_mile_carrier or received_by_last_mile_carrier event is detected by AfterShip. The handover event date is used to calculate the first-mile transit time.- First mile transit time (in days) = Handover date - Pickup date 
-    # transit_time?: String;
+    # transit_time?: Integer;
     attr_accessor :transit_time
 
     # The field provides the link for modifying delivery instructions (such as delivery date and shipping address), if supported by the first-mile carrier. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the destination country/region and language data is unavailable, AfterShip will default the language parameter to "US".
@@ -60,7 +60,7 @@ module AftershipAPI::Model
       {
         :'tracking_number' => :'String',
         :'slug' => :'String',
-        :'transit_time' => :'String',
+        :'transit_time' => :'Integer',
         :'courier_redirect_link' => :'String',
         :'courier_tracking_link' => :'String',
       }

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

@@ -12,7 +12,7 @@ module AftershipAPI::Model
     attr_accessor :slug
 
     # The transit time for the first-mile of a shipment in days. This field is calculated based on whether the handed_over_to_last_mile_carrier or received_by_last_mile_carrier event is detected by AfterShip. The handover event date is used to calculate the first-mile transit time.- First mile transit time (in days) = Handover date - Pickup date 
-    # transit_time?: String;
+    # transit_time?: Integer;
     attr_accessor :transit_time
 
     # The field provides the link for modifying delivery instructions (such as delivery date and shipping address), if supported by the first-mile carrier. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the destination country/region and language data is unavailable, AfterShip will default the language parameter to "US".
@@ -60,7 +60,7 @@ module AftershipAPI::Model
       {
         :'tracking_number' => :'String',
         :'slug' => :'String',
-        :'transit_time' => :'String',
+        :'transit_time' => :'Integer',
         :'courier_redirect_link' => :'String',
         :'courier_tracking_link' => :'String',
       }

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

@@ -12,7 +12,7 @@ module AftershipAPI::Model
     attr_accessor :slug
 
     # The transit time for the first-mile of a shipment in days. This field is calculated based on whether the handed_over_to_last_mile_carrier or received_by_last_mile_carrier event is detected by AfterShip. The handover event date is used to calculate the first-mile transit time.- First mile transit time (in days) = Handover date - Pickup date 
-    # transit_time?: String;
+    # transit_time?: Integer;
     attr_accessor :transit_time
 
     # The field provides the link for modifying delivery instructions (such as delivery date and shipping address), if supported by the first-mile carrier. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the destination country/region and language data is unavailable, AfterShip will default the language parameter to "US".
@@ -60,7 +60,7 @@ module AftershipAPI::Model
       {
         :'tracking_number' => :'String',
         :'slug' => :'String',
-        :'transit_time' => :'String',
+        :'transit_time' => :'Integer',
         :'courier_redirect_link' => :'String',
         :'courier_tracking_link' => :'String',
       }

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

@@ -12,7 +12,7 @@ module AftershipAPI::Model
     attr_accessor :slug
 
     # The transit time for the first-mile of a shipment in days. This field is calculated based on whether the handed_over_to_last_mile_carrier or received_by_last_mile_carrier event is detected by AfterShip. The handover event date is used to calculate the first-mile transit time.- First mile transit time (in days) = Handover date - Pickup date 
-    # transit_time?: String;
+    # transit_time?: Integer;
     attr_accessor :transit_time
 
     # The field provides the link for modifying delivery instructions (such as delivery date and shipping address), if supported by the first-mile carrier. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the destination country/region and language data is unavailable, AfterShip will default the language parameter to "US".
@@ -60,7 +60,7 @@ module AftershipAPI::Model
       {
         :'tracking_number' => :'String',
         :'slug' => :'String',
-        :'transit_time' => :'String',
+        :'transit_time' => :'Integer',
         :'courier_redirect_link' => :'String',
         :'courier_tracking_link' => :'String',
       }

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

@@ -12,7 +12,7 @@ module AftershipAPI::Model
     attr_accessor :slug
 
     # The transit time for the first-mile of a shipment in days. This field is calculated based on whether the handed_over_to_last_mile_carrier or received_by_last_mile_carrier event is detected by AfterShip. The handover event date is used to calculate the first-mile transit time.- First mile transit time (in days) = Handover date - Pickup date 
-    # transit_time?: String;
+    # transit_time?: Integer;
     attr_accessor :transit_time
 
     # The field provides the link for modifying delivery instructions (such as delivery date and shipping address), if supported by the first-mile carrier. The language parameter of this link is determined by the destination country/region and the language associated with the shipment. If the destination country/region and language data is unavailable, AfterShip will default the language parameter to "US".
@@ -60,7 +60,7 @@ module AftershipAPI::Model
       {
         :'tracking_number' => :'String',
         :'slug' => :'String',
-        :'transit_time' => :'String',
+        :'transit_time' => :'Integer',
         :'courier_redirect_link' => :'String',
         :'courier_tracking_link' => :'String',
       }

data/lib/aftership-tracking-sdk/models/get_courier_connections_by_id_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 GetCourierConnectionsByIdResponse
+
+    # The courier connection ID is a special set of numbers generated by AfterShip to define each user-created connection.
+    # id?: String;
+    attr_accessor :id
+
+    # Unique courier code. Get courier codes .
+    # courier_slug?: String;
+    attr_accessor :courier_slug
+
+    # It refers to the authentication details required for each specific carrier details required for each specific carrier (such as API keys, username, password, etc.) that the user must provide to establish a carrier connection. The content varies by carrier.
+    # credentials?: Object;
+    attr_accessor :credentials
+
+    # The date and time the courier connection was created. It uses the format YYYY-MM-DDTHH:mm:ssZ for the timezone GMT +0.
+    # created_at?: String;
+    attr_accessor :created_at
+
+    # The date and time the courier connection was updated. It uses the format YYYY-MM-DDTHH:mm:ssZ for the timezone GMT +0.
+    # updated_at?: String;
+    attr_accessor :updated_at
+
+    # 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::GetCourierConnectionsByIdResponse` 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 
+
+      if attributes.key?(:'courier_slug')
+        self.courier_slug = attributes[:'courier_slug']
+      end 
+
+      if attributes.key?(:'credentials')
+        self.credentials = attributes[:'credentials']
+      end 
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end 
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end 
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'courier_slug' => :'String',
+        :'credentials' => :'Object',
+        :'created_at' => :'String',
+        :'updated_at' => :'String',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'courier_slug' => :'courier_slug',
+        :'credentials' => :'credentials',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at',
+      }
+    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
+