aftership-tracking-sdk 8.0.0 → 10.0.0

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

@@ -4,119 +4,119 @@ require 'uri'
 require 'typhoeus'
 
 module AftershipAPI
-  AUTHENTICATION_TYPE_API_KEY = 'API_KEY'
-  AUTHENTICATION_TYPE_AES = 'AES'
-  AUTHENTICATION_TYPE_RSA = 'RSA'
-  
-  SDK_PREFIX = 'AFTERSHIP_TRACKING_SDK'
-  
-  
-  class Configuration
-    def get_env(key)
-      ENV[SDK_PREFIX + '_' + key]
-    end
-  
-    # Defines domain
-    attr_accessor :domain
-  
-    # Defines the authentication type used in the API.
-    #
-    # @return ["API_KEY", "AES", "RSA"]
-    attr_accessor :authentication_type
-  
-    # Defines API keys used with API Key authentications.
-    #
-    # @return [string]
-    attr_accessor :as_api_key
-  
-    # Defines AES secret or RSA private key used with AES or RSA authentications.
-    #
-    # @return [string]
-    attr_accessor :as_api_secret
-  
-    # Defines the user agent used in the API requests.
-    # Default to 'aftership-sdk-ruby/$VERSION'
-    #
-    # @return [string]
-    attr_accessor :user_agent
-  
-    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
-    # details will be logged with `logger.debug` (see the `logger` attribute).
-    # Default to false.
-    #
-    # @return [true, false]
-    attr_accessor :debugging
-  
-    # Defines the logger used for debugging.
-    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
-    #
-    # @return [#debug]
-    attr_accessor :logger
-  
-    # The time limit for HTTP request in seconds.
-    # Default to 30 
-    attr_accessor :timeout
-  
-    # When response is a retryable error, retry current request
-    # Default to 2
-    attr_accessor :max_retry
-  
-    # HTTP proxy
-    attr_accessor :proxy
+	AUTHENTICATION_TYPE_API_KEY = 'API_KEY'
+	AUTHENTICATION_TYPE_AES = 'AES'
+	AUTHENTICATION_TYPE_RSA = 'RSA'
+  
+	SDK_PREFIX = 'AFTERSHIP_TRACKING_SDK'
+  
+	
+	class Configuration
+	  def get_env(key)
+		ENV[SDK_PREFIX + '_' + key]
+	  end
+  
+	  # Defines domain
+	  attr_accessor :domain
+  
+	  # Defines the authentication type used in the API.
+	  #
+	  # @return ["API_KEY", "AES", "RSA"]
+	  attr_accessor :authentication_type
+  
+	  # Defines API keys used with API Key authentications.
+	  #
+	  # @return [string]
+	  attr_accessor :as_api_key
+  
+	  # Defines AES secret or RSA private key used with AES or RSA authentications.
+	  #
+	  # @return [string]
+	  attr_accessor :as_api_secret
+  
+	  # Defines the user agent used in the API requests.
+	  # Default to 'aftership-sdk-ruby/$VERSION'
+	  #
+	  # @return [string]
+	  attr_accessor :user_agent
+  
+	  # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+	  # details will be logged with `logger.debug` (see the `logger` attribute).
+	  # Default to false.
+	  #
+	  # @return [true, false]
+	  attr_accessor :debugging
+  
+	  # Defines the logger used for debugging.
+	  # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+	  #
+	  # @return [#debug]
+	  attr_accessor :logger
+  
+	  # The time limit for HTTP request in seconds.
+	  # Default to 30 
+	  attr_accessor :timeout
+  
+	  # When response is a retryable error, retry current request
+	  # Default to 2
+	  attr_accessor :max_retry
+  
+	  # HTTP proxy
+	  attr_accessor :proxy
 
-    attr_accessor :aftership_client
+	  attr_accessor :aftership_client
 
-    attr_accessor :headers
+	  attr_accessor :headers
   
   
-    def initialize
-      default_user_agent = "aftership-sdk-ruby/#{AftershipAPI::VERSION} (https://www.aftership.com) typhoeus/#{Typhoeus::VERSION}"
+	  def initialize
+	  	default_user_agent = "aftership-sdk-ruby/#{AftershipAPI::VERSION} (https://www.aftership.com) typhoeus/#{Typhoeus::VERSION}"
 
-      @domain = get_env('DOMAIN') || 'https://api.aftership.com'
-      @authentication_type = get_env('AUTHENTICATION_TYPE') || AUTHENTICATION_TYPE_API_KEY
-      @as_api_key = get_env('API_KEY') || ''
-      @as_api_secret = get_env('API_SECRET') || ''
-      @user_agent = get_env('USER_AGENT') || default_user_agent
-      @aftership_client = default_user_agent
-      @timeout = (get_env('TIMEOUT') || 30).to_i
-      @max_retry = (get_env('MAX_RETRY') || 2).to_i
-      @proxy = get_env('PROXY')
-      @debugging = get_env('DEBUGGING') || false
-      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
-      @headers = {}
+		@domain = get_env('DOMAIN') || 'https://api.aftership.com'
+		@authentication_type = get_env('AUTHENTICATION_TYPE') || AUTHENTICATION_TYPE_API_KEY
+		@as_api_key = get_env('API_KEY') || ''
+		@as_api_secret = get_env('API_SECRET') || ''
+		@user_agent = get_env('USER_AGENT') || default_user_agent
+		@aftership_client = default_user_agent
+		@timeout = (get_env('TIMEOUT') || 30).to_i
+		@max_retry = (get_env('MAX_RETRY') || 2).to_i
+		@proxy = get_env('PROXY')
+		@debugging = get_env('DEBUGGING') || false
+		@logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+		@headers = {}
 
-      yield(self) if block_given?
-    end
-  
-    # The default Configuration object.
-    def self.default
-      @@default ||= Configuration.new
-    end
-  
-    def configure
-      yield(self) if block_given?
-    end
-  
-    def domain=(domain)
-      @domain = domain.sub(/\/+\z/, '')
-    end
-  
-    def check
-      fail InvalidOptionError.new("Invalid authentication type: #{authentication_type}") unless [AUTHENTICATION_TYPE_API_KEY, AUTHENTICATION_TYPE_AES, AUTHENTICATION_TYPE_RSA].include?(authentication_type)
-      fail InvalidOptionError.new("as_api_key cannot be empty") unless as_api_key.to_s.size > 0
-      fail InvalidOptionError.new("Invalid base URL: #{domain}") unless valid_url?(domain)
-      fail InvalidOptionError.new("authentication type must not be API_KEY if as_api_secret is set") if as_api_secret.to_s.size > 0 && authentication_type == AUTHENTICATION_TYPE_API_KEY
-      fail InvalidOptionError.new("timeout cannot be negative, value #{timeout}") unless timeout.to_i >= 0
-      fail InvalidOptionError.new("max_retry must be in range 0..10, value #{max_retry}") unless max_retry.to_i >= 0 and max_retry.to_i <= 10
-      fail InvalidOptionError.new("max_retry cannot be negative, value #{max_retry}") unless max_retry.to_i >= 0
-    end
-  
-    def valid_url?(url)
-      uri = URI.parse(url)
-      uri.is_a?(URI::HTTP) || uri.is_a?(URI::HTTPS)
-      rescue URI::InvalidURIError
-        false
-    end
+		yield(self) if block_given?
+	  end
+  
+	  # The default Configuration object.
+	  def self.default
+		@@default ||= Configuration.new
+	  end
+  
+	  def configure
+		yield(self) if block_given?
+	  end
+  
+	  def domain=(domain)
+		@domain = domain.sub(/\/+\z/, '')
+	  end
+  
+	  def check
+		fail InvalidOptionError.new("Invalid authentication type: #{authentication_type}") unless [AUTHENTICATION_TYPE_API_KEY, AUTHENTICATION_TYPE_AES, AUTHENTICATION_TYPE_RSA].include?(authentication_type)
+		fail InvalidOptionError.new("as_api_key cannot be empty") unless as_api_key.to_s.size > 0
+		fail InvalidOptionError.new("Invalid base URL: #{domain}") unless valid_url?(domain)
+		fail InvalidOptionError.new("authentication type must not be API_KEY if as_api_secret is set") if as_api_secret.to_s.size > 0 && authentication_type == AUTHENTICATION_TYPE_API_KEY
+		fail InvalidOptionError.new("timeout cannot be negative, value #{timeout}") unless timeout.to_i >= 0
+		fail InvalidOptionError.new("max_retry must be in range 0..10, value #{max_retry}") unless max_retry.to_i >= 0 and max_retry.to_i <=10
+		fail InvalidOptionError.new("max_retry cannot be negative, value #{max_retry}") unless max_retry.to_i >= 0
+	  end
+  
+	  def valid_url?(url)
+		uri = URI.parse(url)
+		uri.is_a?(URI::HTTP) || uri.is_a?(URI::HTTPS)
+	  rescue URI::InvalidURIError
+		false
+	  end
+	end
   end
-end
   

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

@@ -7,11 +7,11 @@ module AftershipAPI::Model
     TRACKING_POSTAL_CODE = "tracking_postal_code".freeze
     TRACKING_SHIP_DATE = "tracking_ship_date".freeze
     TRACKING_KEY = "tracking_key".freeze
-    TRACKING_ORIGIN_COUNTRY = "tracking_origin_country".freeze
-    TRACKING_DESTINATION_COUNTRY = "tracking_destination_country".freeze
+    TRACKING_ORIGIN_COUNTRY_REGION = "tracking_origin_country_region".freeze
+    TRACKING_DESTINATION_COUNTRY_REGION = "tracking_destination_country_region".freeze
     TRACKING_STATE = "tracking_state".freeze
     def self.all_vars
-      @all_vars ||= [TRACKING_ACCOUNT_NUMBER, TRACKING_POSTAL_CODE, TRACKING_SHIP_DATE, TRACKING_KEY, TRACKING_ORIGIN_COUNTRY, TRACKING_DESTINATION_COUNTRY, TRACKING_STATE,].freeze
+      @all_vars ||= [TRACKING_ACCOUNT_NUMBER,TRACKING_POSTAL_CODE,TRACKING_SHIP_DATE,TRACKING_KEY,TRACKING_ORIGIN_COUNTRY_REGION,TRACKING_DESTINATION_COUNTRY_REGION,TRACKING_STATE,].freeze
     end
 
     # Builds the enum from string

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class AftershipEstimatedDeliveryDateCreateTrackingResponse
+
     # The estimated arrival date of the shipment.
     # estimated_delivery_date?: String;
     attr_accessor :estimated_delivery_date
@@ -179,3 +180,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class AftershipEstimatedDeliveryDateDeleteTrackingByIdResponse
+
     # The estimated arrival date of the shipment.
     # estimated_delivery_date?: String;
     attr_accessor :estimated_delivery_date
@@ -179,3 +180,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class AftershipEstimatedDeliveryDateGetTrackingByIdResponse
+
     # The estimated arrival date of the shipment.
     # estimated_delivery_date?: String;
     attr_accessor :estimated_delivery_date
@@ -179,3 +180,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class AftershipEstimatedDeliveryDateMarkTrackingCompletedByIdResponse
+
     # The estimated arrival date of the shipment.
     # estimated_delivery_date?: String;
     attr_accessor :estimated_delivery_date
@@ -179,3 +180,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class AftershipEstimatedDeliveryDateRetrackTrackingByIdResponse
+
     # The estimated arrival date of the shipment.
     # estimated_delivery_date?: String;
     attr_accessor :estimated_delivery_date
@@ -179,3 +180,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class AftershipEstimatedDeliveryDateTracking
+
     # The estimated arrival date of the shipment.
     # estimated_delivery_date?: String;
     attr_accessor :estimated_delivery_date
@@ -179,3 +180,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class AftershipEstimatedDeliveryDateUpdateTrackingByIdResponse
+
     # The estimated arrival date of the shipment.
     # estimated_delivery_date?: String;
     attr_accessor :estimated_delivery_date
@@ -179,3 +180,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class CarbonEmissionsCreateTrackingResponse
+
     # The unit in which the value field is expressed. Allowed values: kg
     # unit?: String;
     attr_accessor :unit
@@ -159,3 +160,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class CarbonEmissionsDeleteTrackingByIdResponse
+
     # The unit in which the value field is expressed. Allowed values: kg
     # unit?: String;
     attr_accessor :unit
@@ -159,3 +160,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class CarbonEmissionsGetTrackingByIdResponse
+
     # The unit in which the value field is expressed. Allowed values: kg
     # unit?: String;
     attr_accessor :unit
@@ -159,3 +160,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class CarbonEmissionsMarkTrackingCompletedByIdResponse
+
     # The unit in which the value field is expressed. Allowed values: kg
     # unit?: String;
     attr_accessor :unit
@@ -159,3 +160,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class CarbonEmissionsRetrackTrackingByIdResponse
+
     # The unit in which the value field is expressed. Allowed values: kg
     # unit?: String;
     attr_accessor :unit
@@ -159,3 +160,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class CarbonEmissionsTracking
+
     # The unit in which the value field is expressed. Allowed values: kg
     # unit?: String;
     attr_accessor :unit
@@ -159,3 +160,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class CarbonEmissionsUpdateTrackingByIdResponse
+
     # The unit in which the value field is expressed. Allowed values: kg
     # unit?: String;
     attr_accessor :unit
@@ -159,3 +160,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class Checkpoint
+
     # The date and time of the checkpoint event was added to AfterShip. It uses the format `YYYY-MM-DDTHH:mm:ssZ` for the timezone GMT +0.
     # created_at?: String;
     attr_accessor :created_at
@@ -35,12 +36,12 @@ module AftershipAPI::Model
     attr_accessor :coordinate
 
     # Country/Region ISO Alpha-3 (three letters) of the checkpoint
-    # country_iso3?: String;
-    attr_accessor :country_iso3
+    # country_region?: String;
+    attr_accessor :country_region
 
     # Country/Region name of the checkpoint, may also contain other location info.
-    # country_name?: String;
-    attr_accessor :country_name
+    # country_region_name?: String;
+    attr_accessor :country_region_name
 
     # Checkpoint message
     # message?: String;
@@ -66,6 +67,10 @@ module AftershipAPI::Model
     # events?: EventsCheckpoint[];
     attr_accessor :events
 
+    # The source of the checkpoint, which can either be from the carrier or when the user marks the tracking as completed.
+    # source?: String;
+    attr_accessor :source
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -109,12 +114,12 @@ module AftershipAPI::Model
         self.coordinate = attributes[:'coordinate']
       end 
 
-      if attributes.key?(:'country_iso3')
-        self.country_iso3 = attributes[:'country_iso3']
+      if attributes.key?(:'country_region')
+        self.country_region = attributes[:'country_region']
       end 
 
-      if attributes.key?(:'country_name')
-        self.country_name = attributes[:'country_name']
+      if attributes.key?(:'country_region_name')
+        self.country_region_name = attributes[:'country_region_name']
       end 
 
       if attributes.key?(:'message')
@@ -140,6 +145,10 @@ module AftershipAPI::Model
       if attributes.key?(:'events')
         self.events = attributes[:'events']
       end 
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      end 
     end
 
     # Attribute type mapping.
@@ -153,14 +162,15 @@ module AftershipAPI::Model
         :'state' => :'String',
         :'zip' => :'String',
         :'coordinate' => :'CoordinateCheckpoint',
-        :'country_iso3' => :'String',
-        :'country_name' => :'String',
+        :'country_region' => :'String',
+        :'country_region_name' => :'String',
         :'message' => :'String',
         :'tag' => :'TagV1',
         :'subtag' => :'String',
         :'subtag_message' => :'String',
         :'raw_tag' => :'String',
         :'events' => :'Array<EventsCheckpoint>',
+        :'source' => :'String',
       }
     end
 
@@ -175,14 +185,15 @@ module AftershipAPI::Model
         :'state' => :'state',
         :'zip' => :'zip',
         :'coordinate' => :'coordinate',
-        :'country_iso3' => :'country_iso3',
-        :'country_name' => :'country_name',
+        :'country_region' => :'country_region',
+        :'country_region_name' => :'country_region_name',
         :'message' => :'message',
         :'tag' => :'tag',
         :'subtag' => :'subtag',
         :'subtag_message' => :'subtag_message',
         :'raw_tag' => :'raw_tag',
         :'events' => :'events',
+        :'source' => :'source',
       }
     end
 
@@ -299,3 +310,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class CoordinateCheckpoint
+
     # Represents the latitude.
     # latitude?: Float;
     attr_accessor :latitude
@@ -159,3 +160,4 @@ module AftershipAPI::Model
     end
   end
 end
+

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

@@ -2,6 +2,7 @@
 # Do not edit the class manually.
 module AftershipAPI::Model
   class Courier
+
     # Unique code of courier. Get the slugs from .
     # slug?: String;
     attr_accessor :slug
@@ -22,7 +23,7 @@ module AftershipAPI::Model
     # web_url?: String;
     attr_accessor :web_url
 
-    # The extra fields need for tracking, such as `tracking_account_number`, `tracking_postal_code`, `tracking_ship_date`, `tracking_key`, `tracking_destination_country`
+    # The extra fields need for tracking, such as `tracking_account_number`, `tracking_postal_code`, `tracking_ship_date`, `tracking_key`, `tracking_destination_country_region`
     # required_fields?: String[];
     attr_accessor :required_fields
 
@@ -39,8 +40,8 @@ module AftershipAPI::Model
     attr_accessor :support_languages
 
     # Country/Region code (ISO Alpha-3) where the courier provides service
-    # service_from_country_iso3?: String[];
-    attr_accessor :service_from_country_iso3
+    # service_from_country_regions?: String[];
+    attr_accessor :service_from_country_regions
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
@@ -89,8 +90,8 @@ module AftershipAPI::Model
         self.support_languages = attributes[:'support_languages']
       end 
 
-      if attributes.key?(:'service_from_country_iso3')
-        self.service_from_country_iso3 = attributes[:'service_from_country_iso3']
+      if attributes.key?(:'service_from_country_regions')
+        self.service_from_country_regions = attributes[:'service_from_country_regions']
       end 
     end
 
@@ -106,7 +107,7 @@ module AftershipAPI::Model
         :'optional_fields' => :'Array<String>',
         :'default_language' => :'String',
         :'support_languages' => :'Array<String>',
-        :'service_from_country_iso3' => :'Array<String>',
+        :'service_from_country_regions' => :'Array<String>',
       }
     end
 
@@ -122,7 +123,7 @@ module AftershipAPI::Model
         :'optional_fields' => :'optional_fields',
         :'default_language' => :'default_language',
         :'support_languages' => :'support_languages',
-        :'service_from_country_iso3' => :'service_from_country_iso3',
+        :'service_from_country_regions' => :'service_from_country_regions',
       }
     end
 
@@ -239,3 +240,4 @@ module AftershipAPI::Model
     end
   end
 end
+