aftership-tracking-sdk 11.0.0 → 13.0.0

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

@@ -1,19 +1,18 @@
 # This code was auto generated by AfterShip SDK Generator.
 # Do not edit the class manually.
-
 module AftershipAPI::Model
   class Tag
     PENDING = "Pending".freeze
-    INFORECEIVED = "InfoReceived".freeze
-    INTRANSIT = "InTransit".freeze
-    OUTFORDELIVERY = "OutForDelivery".freeze
-    ATTEMPTFAIL = "AttemptFail".freeze
+    INFO_RECEIVED = "InfoReceived".freeze
+    IN_TRANSIT = "InTransit".freeze
+    OUT_FOR_DELIVERY = "OutForDelivery".freeze
+    ATTEMPT_FAIL = "AttemptFail".freeze
     DELIVERED = "Delivered".freeze
-    AVAILABLEFORPICKUP = "AvailableForPickup".freeze
+    AVAILABLE_FOR_PICKUP = "AvailableForPickup".freeze
     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, INFO_RECEIVED, IN_TRANSIT, OUT_FOR_DELIVERY, ATTEMPT_FAIL, DELIVERED, AVAILABLE_FOR_PICKUP, EXCEPTION, EXPIRED,].freeze
     end
 
     # Builds the enum from string

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

@@ -2,7 +2,6 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class Tracking
-
     # A  system-generated tracking ID by default, which can be customized by the user when creating a tracking.
     # id?: String;
     attr_accessor :id
@@ -84,7 +83,7 @@ module AftershipAPI::Model
     attr_accessor :courier_destination_country_region
 
     # The field contains the estimated delivery date provided by the carrier.
-    # courier_estimated_delivery_date?: CourierEstimatedDeliveryDateTracking;
+    # courier_estimated_delivery_date?: TrackingCourierEstimatedDeliveryDate;
     attr_accessor :courier_estimated_delivery_date
 
     # Text field for the note.
@@ -120,7 +119,7 @@ module AftershipAPI::Model
     attr_accessor :shipment_type
 
     # 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;
+    # shipment_weight?: TrackingShipmentWeight;
     attr_accessor :shipment_weight
 
     # Signed by information for delivered shipment.
@@ -232,11 +231,11 @@ module AftershipAPI::Model
     attr_accessor :order_tags
 
     # The estimated delivery date of the shipment provided by AfterShip’s AI and shown to the recipients. It uses the format `YYYY-MM-DD` based on the shipment recipient’s timezone.
-    # aftership_estimated_delivery_date?: AftershipEstimatedDeliveryDateTracking;
+    # aftership_estimated_delivery_date?: TrackingAftershipEstimatedDeliveryDate;
     attr_accessor :aftership_estimated_delivery_date
 
     # Estimated delivery time of the shipment based on your . It uses the format `YYYY-MM-DD` based on the shipment recipient’s timezone.
-    # custom_estimated_delivery_date?: CustomEstimatedDeliveryDateTracking;
+    # custom_estimated_delivery_date?: TrackingCustomEstimatedDeliveryDate;
     attr_accessor :custom_estimated_delivery_date
 
     # A unique, human-readable identifier for the order.
@@ -244,11 +243,11 @@ module AftershipAPI::Model
     attr_accessor :order_number
 
     # The shipment’s original estimated delivery date. It could be provided by the carrier, AfterShip AI, or based on your custom settings. The format of carrier EDDs may differ depending on how the carrier provides it:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ AfterShip AI and custom EDDs always use the format `YYYY-MM-DD`. All EDDs use the shipment recipient’s timezone.
-    # first_estimated_delivery?: FirstEstimatedDeliveryTracking;
+    # first_estimated_delivery?: TrackingFirstEstimatedDelivery;
     attr_accessor :first_estimated_delivery
 
     # The most recently calculated estimated delivery date. It could be provided by the carrier, AfterShip AI, or based on your custom settings. The format of carrier EDDs may differ depending on how the carrier provides it:- YYYY-MM-DD- YYYY-MM-DDTHH:mm:ss- YYYY-MM-DDTHH:mm:ssZ AfterShip AI and custom EDDs always use the format `YYYY-MM-DD`. All EDDs use the shipment recipient’s timezone.
-    # latest_estimated_delivery?: LatestEstimatedDeliveryTracking;
+    # latest_estimated_delivery?: TrackingLatestEstimatedDelivery;
     attr_accessor :latest_estimated_delivery
 
     # Used to add tags to your shipments to help categorize and filter them easily.
@@ -260,7 +259,7 @@ module AftershipAPI::Model
     attr_accessor :courier_connection_id
 
     # 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?: CarbonEmissionsTracking;
+    # carbon_emissions?: TrackingCarbonEmissions;
     attr_accessor :carbon_emissions
 
     # The location_id refers to the place where you fulfilled the items.  - If you provide a location_id, the system will automatically use it as the tracking's origin address. However, passing both location_id and any origin address information simultaneously is not allowed.- Please make sure you add your locations .
@@ -276,7 +275,7 @@ module AftershipAPI::Model
     attr_accessor :failed_delivery_attempts
 
     # The signature_requirement field serves the purpose of validating the service option type, specifically proof of delivery. By collecting the recipient's signature upon delivery, it ensures the package reaches the intended recipient and prevents disputes related to non-delivery or lost packages.</br>
-    # signature_requirement?: String;
+    # signature_requirement?: TrackingSignatureRequirement;
     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.
@@ -292,15 +291,15 @@ module AftershipAPI::Model
     attr_accessor :aftership_tracking_order_url
 
     # The field contains information about the first leg of the shipping starting from the carrier picking up the shipment from the shipper to the point where they hand it over to the last-mile carrier. Once AfterShip detects the shipment is multi-leg, we will populate the first-mile information under this object. 
-    # first_mile?: FirstMileTracking;
+    # first_mile?: TrackingFirstMile;
     attr_accessor :first_mile
 
     # 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?: LastMileTracking;
+    # last_mile?: TrackingLastMile;
     attr_accessor :last_mile
 
     # The field contains the customer information associated with the tracking. A maximum of three customer objects are allowed.
-    # customers?: CustomersTracking[];
+    # customers?: TrackingCustomers[];
     attr_accessor :customers
 
     # Initializes the object
@@ -316,303 +315,303 @@ module AftershipAPI::Model
 
       if attributes.key?(:'id')
         self.id = attributes[:'id']
-      end 
+      end
 
       if attributes.key?(:'legacy_id')
         self.legacy_id = attributes[:'legacy_id']
-      end 
+      end
 
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
-      end 
+      end
 
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
-      end 
+      end
 
       if attributes.key?(:'tracking_number')
         self.tracking_number = attributes[:'tracking_number']
-      end 
+      end
 
       if attributes.key?(:'slug')
         self.slug = attributes[:'slug']
-      end 
+      end
 
       if attributes.key?(:'active')
         self.active = attributes[:'active']
-      end 
+      end
 
       if attributes.key?(:'custom_fields')
         self.custom_fields = attributes[:'custom_fields']
-      end 
+      end
 
       if attributes.key?(:'transit_time')
         self.transit_time = attributes[:'transit_time']
-      end 
+      end
 
       if attributes.key?(:'origin_country_region')
         self.origin_country_region = attributes[:'origin_country_region']
-      end 
+      end
 
       if attributes.key?(:'origin_state')
         self.origin_state = attributes[:'origin_state']
-      end 
+      end
 
       if attributes.key?(:'origin_city')
         self.origin_city = attributes[:'origin_city']
-      end 
+      end
 
       if attributes.key?(:'origin_postal_code')
         self.origin_postal_code = attributes[:'origin_postal_code']
-      end 
+      end
 
       if attributes.key?(:'origin_raw_location')
         self.origin_raw_location = attributes[:'origin_raw_location']
-      end 
+      end
 
       if attributes.key?(:'destination_country_region')
         self.destination_country_region = attributes[:'destination_country_region']
-      end 
+      end
 
       if attributes.key?(:'destination_state')
         self.destination_state = attributes[:'destination_state']
-      end 
+      end
 
       if attributes.key?(:'destination_city')
         self.destination_city = attributes[:'destination_city']
-      end 
+      end
 
       if attributes.key?(:'destination_postal_code')
         self.destination_postal_code = attributes[:'destination_postal_code']
-      end 
+      end
 
       if attributes.key?(:'destination_raw_location')
         self.destination_raw_location = attributes[:'destination_raw_location']
-      end 
+      end
 
       if attributes.key?(:'courier_destination_country_region')
         self.courier_destination_country_region = attributes[:'courier_destination_country_region']
-      end 
+      end
 
       if attributes.key?(:'courier_estimated_delivery_date')
         self.courier_estimated_delivery_date = attributes[:'courier_estimated_delivery_date']
-      end 
+      end
 
       if attributes.key?(:'note')
         self.note = attributes[:'note']
-      end 
+      end
 
       if attributes.key?(:'order_id')
         self.order_id = attributes[:'order_id']
-      end 
+      end
 
       if attributes.key?(:'order_id_path')
         self.order_id_path = attributes[:'order_id_path']
-      end 
+      end
 
       if attributes.key?(:'order_date')
         self.order_date = attributes[:'order_date']
-      end 
+      end
 
       if attributes.key?(:'shipment_package_count')
         self.shipment_package_count = attributes[:'shipment_package_count']
-      end 
+      end
 
       if attributes.key?(:'shipment_pickup_date')
         self.shipment_pickup_date = attributes[:'shipment_pickup_date']
-      end 
+      end
 
       if attributes.key?(:'shipment_delivery_date')
         self.shipment_delivery_date = attributes[:'shipment_delivery_date']
-      end 
+      end
 
       if attributes.key?(:'shipment_type')
         self.shipment_type = attributes[:'shipment_type']
-      end 
+      end
 
       if attributes.key?(:'shipment_weight')
         self.shipment_weight = attributes[:'shipment_weight']
-      end 
+      end
 
       if attributes.key?(:'signed_by')
         self.signed_by = attributes[:'signed_by']
-      end 
+      end
 
       if attributes.key?(:'source')
         self.source = attributes[:'source']
-      end 
+      end
 
       if attributes.key?(:'tag')
         self.tag = attributes[:'tag']
-      end 
+      end
 
       if attributes.key?(:'subtag')
         self.subtag = attributes[:'subtag']
-      end 
+      end
 
       if attributes.key?(:'subtag_message')
         self.subtag_message = attributes[:'subtag_message']
-      end 
+      end
 
       if attributes.key?(:'title')
         self.title = attributes[:'title']
-      end 
+      end
 
       if attributes.key?(:'tracked_count')
         self.tracked_count = attributes[:'tracked_count']
-      end 
+      end
 
       if attributes.key?(:'last_mile_tracking_supported')
         self.last_mile_tracking_supported = attributes[:'last_mile_tracking_supported']
-      end 
+      end
 
       if attributes.key?(:'language')
         self.language = attributes[:'language']
-      end 
+      end
 
       if attributes.key?(:'unique_token')
         self.unique_token = attributes[:'unique_token']
-      end 
+      end
 
       if attributes.key?(:'checkpoints')
         self.checkpoints = attributes[:'checkpoints']
-      end 
+      end
 
       if attributes.key?(:'subscribed_smses')
         self.subscribed_smses = attributes[:'subscribed_smses']
-      end 
+      end
 
       if attributes.key?(:'subscribed_emails')
         self.subscribed_emails = attributes[:'subscribed_emails']
-      end 
+      end
 
       if attributes.key?(:'return_to_sender')
         self.return_to_sender = attributes[:'return_to_sender']
-      end 
+      end
 
       if attributes.key?(:'order_promised_delivery_date')
         self.order_promised_delivery_date = attributes[:'order_promised_delivery_date']
-      end 
+      end
 
       if attributes.key?(:'delivery_type')
         self.delivery_type = attributes[:'delivery_type']
-      end 
+      end
 
       if attributes.key?(:'pickup_location')
         self.pickup_location = attributes[:'pickup_location']
-      end 
+      end
 
       if attributes.key?(:'pickup_note')
         self.pickup_note = attributes[:'pickup_note']
-      end 
+      end
 
       if attributes.key?(:'courier_tracking_link')
         self.courier_tracking_link = attributes[:'courier_tracking_link']
-      end 
+      end
 
       if attributes.key?(:'first_attempted_at')
         self.first_attempted_at = attributes[:'first_attempted_at']
-      end 
+      end
 
       if attributes.key?(:'courier_redirect_link')
         self.courier_redirect_link = attributes[:'courier_redirect_link']
-      end 
+      end
 
       if attributes.key?(:'tracking_account_number')
         self.tracking_account_number = attributes[:'tracking_account_number']
-      end 
+      end
 
       if attributes.key?(:'tracking_key')
         self.tracking_key = attributes[:'tracking_key']
-      end 
+      end
 
       if attributes.key?(:'tracking_ship_date')
         self.tracking_ship_date = attributes[:'tracking_ship_date']
-      end 
+      end
 
       if attributes.key?(:'on_time_status')
         self.on_time_status = attributes[:'on_time_status']
-      end 
+      end
 
       if attributes.key?(:'on_time_difference')
         self.on_time_difference = attributes[:'on_time_difference']
-      end 
+      end
 
       if attributes.key?(:'order_tags')
         self.order_tags = attributes[:'order_tags']
-      end 
+      end
 
       if attributes.key?(:'aftership_estimated_delivery_date')
         self.aftership_estimated_delivery_date = attributes[:'aftership_estimated_delivery_date']
-      end 
+      end
 
       if attributes.key?(:'custom_estimated_delivery_date')
         self.custom_estimated_delivery_date = attributes[:'custom_estimated_delivery_date']
-      end 
+      end
 
       if attributes.key?(:'order_number')
         self.order_number = attributes[:'order_number']
-      end 
+      end
 
       if attributes.key?(:'first_estimated_delivery')
         self.first_estimated_delivery = attributes[:'first_estimated_delivery']
-      end 
+      end
 
       if attributes.key?(:'latest_estimated_delivery')
         self.latest_estimated_delivery = attributes[:'latest_estimated_delivery']
-      end 
+      end
 
       if attributes.key?(:'shipment_tags')
         self.shipment_tags = attributes[:'shipment_tags']
-      end 
+      end
 
       if attributes.key?(:'courier_connection_id')
         self.courier_connection_id = attributes[:'courier_connection_id']
-      end 
+      end
 
       if attributes.key?(:'carbon_emissions')
         self.carbon_emissions = attributes[:'carbon_emissions']
-      end 
+      end
 
       if attributes.key?(:'location_id')
         self.location_id = attributes[:'location_id']
-      end 
+      end
 
       if attributes.key?(:'shipping_method')
         self.shipping_method = attributes[:'shipping_method']
-      end 
+      end
 
       if attributes.key?(:'failed_delivery_attempts')
         self.failed_delivery_attempts = attributes[:'failed_delivery_attempts']
-      end 
+      end
 
       if attributes.key?(:'signature_requirement')
         self.signature_requirement = attributes[:'signature_requirement']
-      end 
+      end
 
       if attributes.key?(:'delivery_location_type')
         self.delivery_location_type = attributes[:'delivery_location_type']
-      end 
+      end
 
       if attributes.key?(:'aftership_tracking_url')
         self.aftership_tracking_url = attributes[:'aftership_tracking_url']
-      end 
+      end
 
       if attributes.key?(:'aftership_tracking_order_url')
         self.aftership_tracking_order_url = attributes[:'aftership_tracking_order_url']
-      end 
+      end
 
       if attributes.key?(:'first_mile')
         self.first_mile = attributes[:'first_mile']
-      end 
+      end
 
       if attributes.key?(:'last_mile')
         self.last_mile = attributes[:'last_mile']
-      end 
+      end
 
       if attributes.key?(:'customers')
         self.customers = attributes[:'customers']
-      end 
+      end
     end
 
     # Attribute type mapping.
@@ -638,7 +637,7 @@ module AftershipAPI::Model
         :'destination_postal_code' => :'String',
         :'destination_raw_location' => :'String',
         :'courier_destination_country_region' => :'String',
-        :'courier_estimated_delivery_date' => :'CourierEstimatedDeliveryDateTracking',
+        :'courier_estimated_delivery_date' => :'TrackingCourierEstimatedDeliveryDate',
         :'note' => :'String',
         :'order_id' => :'String',
         :'order_id_path' => :'String',
@@ -647,7 +646,7 @@ module AftershipAPI::Model
         :'shipment_pickup_date' => :'String',
         :'shipment_delivery_date' => :'String',
         :'shipment_type' => :'String',
-        :'shipment_weight' => :'ShipmentWeightTracking',
+        :'shipment_weight' => :'TrackingShipmentWeight',
         :'signed_by' => :'String',
         :'source' => :'String',
         :'tag' => :'Tag',
@@ -675,24 +674,24 @@ module AftershipAPI::Model
         :'on_time_status' => :'String',
         :'on_time_difference' => :'Float',
         :'order_tags' => :'Array<String>',
-        :'aftership_estimated_delivery_date' => :'AftershipEstimatedDeliveryDateTracking',
-        :'custom_estimated_delivery_date' => :'CustomEstimatedDeliveryDateTracking',
+        :'aftership_estimated_delivery_date' => :'TrackingAftershipEstimatedDeliveryDate',
+        :'custom_estimated_delivery_date' => :'TrackingCustomEstimatedDeliveryDate',
         :'order_number' => :'String',
-        :'first_estimated_delivery' => :'FirstEstimatedDeliveryTracking',
-        :'latest_estimated_delivery' => :'LatestEstimatedDeliveryTracking',
+        :'first_estimated_delivery' => :'TrackingFirstEstimatedDelivery',
+        :'latest_estimated_delivery' => :'TrackingLatestEstimatedDelivery',
         :'shipment_tags' => :'Array<String>',
         :'courier_connection_id' => :'String',
-        :'carbon_emissions' => :'CarbonEmissionsTracking',
+        :'carbon_emissions' => :'TrackingCarbonEmissions',
         :'location_id' => :'String',
         :'shipping_method' => :'String',
         :'failed_delivery_attempts' => :'Integer',
-        :'signature_requirement' => :'String',
+        :'signature_requirement' => :'TrackingSignatureRequirement',
         :'delivery_location_type' => :'String',
         :'aftership_tracking_url' => :'String',
         :'aftership_tracking_order_url' => :'String',
-        :'first_mile' => :'FirstMileTracking',
-        :'last_mile' => :'LastMileTracking',
-        :'customers' => :'Array<CustomersTracking>',
+        :'first_mile' => :'TrackingFirstMile',
+        :'last_mile' => :'TrackingLastMile',
+        :'customers' => :'Array<TrackingCustomers>',
       }
     end
 
@@ -890,4 +889,3 @@ module AftershipAPI::Model
     end
   end
 end
-

data/lib/aftership-tracking-sdk/models/{aftership_estimated_delivery_date_tracking.rb → tracking_aftership_estimated_delivery_date.rb}

@@ -1,8 +1,7 @@
 # This code was auto generated by AfterShip SDK Generator.
 # Do not edit the class manually.
 module AftershipAPI::Model
-  class AftershipEstimatedDeliveryDateTracking
-
+  class TrackingAftershipEstimatedDeliveryDate
     # The estimated arrival date of the shipment.
     # estimated_delivery_date?: String;
     attr_accessor :estimated_delivery_date
@@ -23,7 +22,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::AftershipEstimatedDeliveryDateTracking` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::TrackingAftershipEstimatedDeliveryDate` initialize method"
       end
 
       attributes = attributes.each_with_object({}) { |(k, v), h|
@@ -32,19 +31,19 @@ module AftershipAPI::Model
 
       if attributes.key?(:'estimated_delivery_date')
         self.estimated_delivery_date = attributes[:'estimated_delivery_date']
-      end 
+      end
 
       if attributes.key?(:'confidence_code')
         self.confidence_code = attributes[:'confidence_code']
-      end 
+      end
 
       if attributes.key?(:'estimated_delivery_date_min')
         self.estimated_delivery_date_min = attributes[:'estimated_delivery_date_min']
-      end 
+      end
 
       if attributes.key?(:'estimated_delivery_date_max')
         self.estimated_delivery_date_max = attributes[:'estimated_delivery_date_max']
-      end 
+      end
     end
 
     # Attribute type mapping.
@@ -180,4 +179,3 @@ module AftershipAPI::Model
     end
   end
 end
-

data/lib/aftership-tracking-sdk/models/{carbon_emissions_tracking.rb → tracking_carbon_emissions.rb}

@@ -1,8 +1,7 @@
 # This code was auto generated by AfterShip SDK Generator.
 # Do not edit the class manually.
 module AftershipAPI::Model
-  class CarbonEmissionsTracking
-
+  class TrackingCarbonEmissions
     # The unit in which the value field is expressed. Allowed values: kg
     # unit?: String;
     attr_accessor :unit
@@ -15,7 +14,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::CarbonEmissionsTracking` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::TrackingCarbonEmissions` initialize method"
       end
 
       attributes = attributes.each_with_object({}) { |(k, v), h|
@@ -24,11 +23,11 @@ module AftershipAPI::Model
 
       if attributes.key?(:'unit')
         self.unit = attributes[:'unit']
-      end 
+      end
 
       if attributes.key?(:'value')
         self.value = attributes[:'value']
-      end 
+      end
     end
 
     # Attribute type mapping.
@@ -160,4 +159,3 @@ module AftershipAPI::Model
     end
   end
 end
-