aftership-tracking-sdk 7.0.0

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

@@ -0,0 +1,426 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+require 'json'
+require 'logger'
+require 'tempfile'
+require 'time'
+require 'typhoeus'
+
+module AftershipAPI
+  class ApiClient
+    BASE_DELAY_SECONDS = 3
+
+    # The Configuration object holding settings to be used in the API client.
+    attr_accessor :config
+
+    # Defines the headers to be used in HTTP requests of all API calls by default.
+    #
+    # @return [Hash]
+    attr_accessor :default_headers
+
+    # Initializes the ApiClient
+    # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
+    def initialize(config = Configuration.default)
+      @config = config
+      @user_agent = config.user_agent 
+      @aftership_client = config.aftership_client
+      @default_headers = @config.headers.merge({
+        'Content-Type' => 'application/json',
+        'User-Agent' => @user_agent,
+        'aftership-client' => @aftership_client
+      })
+    end
+
+    def self.default
+      @@default ||= ApiClient.new
+    end
+
+    # Call an API with given options.
+    #
+    # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
+    #   the data deserialized from response body (may be a Tempfile or nil), response status code and response headers.
+    def call_api(http_method, path, opts = {})
+      retries = @config.max_retry || 0
+      begin
+        call_api_internal(http_method, path, opts)
+      rescue ApiError => e
+        if retries > 0 && (e.error_code == AftershipAPI::TIMED_OUT || e.status_code >= 500)
+          retries -= 1
+          delay_with_jitter
+          retry
+        else
+          raise e
+        end
+      end
+    end
+
+    # base delay is 3 seconds
+    def delay_with_jitter
+      delay = rand((BASE_DELAY_SECONDS / 2.0)..(BASE_DELAY_SECONDS * 2.0))
+      sleep delay
+    end
+
+    def call_api_internal(http_method, path, opts = {})
+      request = build_request(http_method, path, opts)
+      tempfile = download_file(request) if opts[:return_type] == 'File'
+      response = request.run
+
+      raise ApiError.new(:error_code => AftershipAPI::TIMED_OUT, :status_code => 0, :message => 'No response received') if response.timed_out?
+
+      if @config.debugging
+        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+      end
+
+      unless response.success?
+        if response.timed_out?
+          fail ApiError.new(:error_code => AftershipAPI::TIMED_OUT, :message => 'Request timed out!')
+        elsif response.code == 0
+          # Errors from libcurl will be made visible here
+          fail ApiError.new(:status_code => 0,
+                            :message => response.return_message)
+        else
+          fail ApiError.new(:status_code => response.code,
+                            :response_headers => response.headers,
+                            :response_body => response.body),
+              response.status_message
+        end
+      end
+
+      if opts[:return_type] == 'File'
+        data = tempfile
+      elsif opts[:return_type]
+        data = deserialize(response, opts[:return_type], opts[:response_legacy_tag], opts[:is_paging])
+      else
+        data = nil
+      end
+      return data, response.code, response.headers
+    end
+
+    # Builds the HTTP request
+    #
+    # @param [String] http_method HTTP method/verb (e.g. POST)
+    # @param [String] path URL path (e.g. /account/new)
+    # @option opts [Hash] :header_params Header parameters
+    # @option opts [Hash] :query_params Query parameters
+    # @option opts [Hash] :form_params Query parameters
+    # @option opts [Object] :body HTTP body (JSON/XML)
+    # @return [Typhoeus::Request] A Typhoeus Request
+    def build_request(http_method, path, opts = {})
+      url = build_request_url(path, opts)
+      http_method = http_method.to_sym.downcase
+
+      header_params = @default_headers.merge(opts[:header_params] || {}).merge({ 'as-api-key' => config.as_api_key })
+      query_params = opts[:query_params] || {}
+      form_params = opts[:form_params] || {}
+      follow_location = opts[:follow_location] || true
+
+      header_params['date'] = Time.now.httpdate
+
+      req_opts = {
+        :method => http_method,
+        :headers => header_params,
+        :params => query_params,
+        :timeout => @config.timeout,
+        :verbose => @config.debugging,
+        :followlocation => follow_location,
+        :proxy => @config.proxy
+      }
+
+      if [:post, :patch, :put, :delete].include?(http_method)
+        req_body = build_request_body(header_params, form_params, opts[:body])
+        req_opts.update :body => req_body
+        if req_body.to_s.size == 0 
+          req_opts[:headers]['Content-Type'] = ''
+        end
+        if @config.debugging
+          @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
+        end
+      end
+
+      if @config.authentication_type == AUTHENTICATION_TYPE_AES || @config.authentication_type == AUTHENTICATION_TYPE_RSA
+        signature_header = @config.authentication_type == AUTHENTICATION_TYPE_AES ? "as-signature-hmac-sha256" : "as-signature-rsa-sha256"
+        req_opts[:headers][signature_header] = SignString.sign({
+          'method' => http_method,
+          'headers' => req_opts[:headers],
+          'body' => req_opts[:body] || '',
+          'content_type' => header_params['Content-Type'],
+          'date' => header_params['date'],
+          'url' => url,
+          'query' => query_params,
+          'auth_type' => @config.authentication_type,
+          'secret' => @config.as_api_secret
+        })
+      end
+
+      Typhoeus::Request.new(url, req_opts)
+    end
+
+    # Builds the HTTP request body
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] form_params Query parameters
+    # @param [Object] body HTTP body (JSON/XML)
+    # @return [String] HTTP body data in the form of string
+    def build_request_body(header_params, form_params, body)
+      # http form
+      if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
+          header_params['Content-Type'] == 'multipart/form-data'
+        data = {}
+        form_params.each do |key, value|
+          case value
+          when ::File, ::Array, nil
+            # let typhoeus handle File, Array and nil parameters
+            data[key] = value
+          else
+            data[key] = value.to_s
+          end
+        end
+      elsif body
+        data = body.is_a?(String) ? body : body.to_json
+      else
+        data = nil
+      end
+      data
+    end
+
+    # Save response body into a file in (the defined) temporary folder, using the filename
+    # from the "Content-Disposition" header if provided, otherwise a random filename.
+    # The response body is written to the file in chunks in order to handle files which
+    # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
+    # process can use.
+    #
+    # @see Configuration#temp_folder_path
+    #
+    # @return [Tempfile] the tempfile generated
+    def download_file(request)
+      tempfile = nil
+      encoding = nil
+      request.on_headers do |response|
+        content_disposition = response.headers['Content-Disposition']
+        if content_disposition && content_disposition =~ /filename=/i
+          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+          prefix = sanitize_filename(filename)
+        else
+          prefix = 'download-'
+        end
+        prefix = prefix + '-' unless prefix.end_with?('-')
+        encoding = response.body.encoding
+        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+      end
+      request.on_body do |chunk|
+        chunk.force_encoding(encoding)
+        tempfile.write(chunk)
+      end
+      # run the request to ensure the tempfile is created successfully before returning it
+      request.run
+      if tempfile
+        tempfile.close
+        @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                            "explicitly with `tempfile.delete`"
+      else
+        fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}") 
+      end
+
+      tempfile
+    end
+
+    # Check if the given MIME is a JSON MIME.
+    # JSON MIME examples:
+    #   application/json
+    #   application/json; charset=UTF8
+    #   APPLICATION/JSON
+    #   */*
+    # @param [String] mime MIME
+    # @return [Boolean] True if the MIME is application/json
+    def json_mime?(mime)
+      (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
+    end
+
+    # Deserialize the response to the given return type.
+    #
+    # @param [Response] response HTTP response
+    # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
+    # @param [String] response_legacy_tag {tracking: Tracking{}} where response_legacy_tag is "tracking"
+    # @param [Boolean] is_paging
+    def deserialize(response, return_type, response_legacy_tag, is_paging)
+      body = response.body
+      return nil if body.nil? || body.empty?
+
+      # return response body directly for String return type
+      return body.to_s if return_type == 'String'
+
+      # ensuring a default content type
+      content_type = response.headers['Content-Type'] || 'application/json'
+
+      fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
+
+      begin
+        data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
+      rescue JSON::ParserError => e
+        if %w(String Date Time).include?(return_type)
+          data = body
+        else
+          raise e
+        end
+      end
+
+      convert_to_type handle_data(response_legacy_tag, is_paging, data), return_type
+    end
+
+    def handle_data(response_legacy_tag, is_paging, data) 
+      if response_legacy_tag.to_s != "" && !is_paging
+        return data[:data][response_legacy_tag.to_sym]
+      end
+
+      if response_legacy_tag.to_s != "" && is_paging
+        pagination = {
+          page: data[:data][:page],
+          limit: data[:data][:limit],
+          has_next_page: data[:data][:has_next_page],
+        }
+
+        total = data[:data][:total]
+        total = data[:data][:count] if total.nil?
+        pagination[:total] = total  
+        return {
+          pagination: pagination,
+          response_legacy_tag.to_sym => data[:data][response_legacy_tag.to_sym]
+        }
+      end
+
+      data[:data]
+    end
+
+    # Convert data to the given return type.
+    # @param [Object] data Data to be converted
+    # @param [String] return_type Return type
+    # @return [Mixed] Data in a particular type
+    def convert_to_type(data, return_type)
+      return nil if data.nil?
+      case return_type
+      when 'String'
+        data.to_s
+      when 'Integer'
+        data.to_i
+      when 'Float'
+        data.to_f
+      when 'Boolean'
+        data == true
+      when 'Time'
+        # parse date time (expecting ISO 8601 format)
+        Time.parse data
+      when 'Date'
+        # parse date time (expecting ISO 8601 format)
+        Date.parse data
+      when 'Object'
+        # generic object (usually a Hash), return directly
+        data
+      when /\AArray<(.+)>\z/
+        # e.g. Array<Pet>
+        sub_type = $1
+        data.map { |item| convert_to_type(item, sub_type) }
+      when /\AHash\<String, (.+)\>\z/
+        # e.g. Hash<String, Integer>
+        sub_type = $1
+        {}.tap do |hash|
+          data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
+        end
+      else
+        # models (e.g. Pet) or oneOf
+        klass = AftershipAPI::Model.const_get(return_type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
+      end
+    end
+
+    # Sanitize filename by removing path.
+    # e.g. ../../sun.gif becomes sun.gif
+    #
+    # @param [String] filename the filename to be sanitized
+    # @return [String] the sanitized filename
+    def sanitize_filename(filename)
+      filename.gsub(/.*[\/\\]/, '')
+    end
+
+    def build_request_url(path, opts = {})
+      # Add leading and trailing slashes to path
+      path = "/#{path}".gsub(/\/+/, '/')
+      @config.domain + path
+    end
+
+    # Sets user agent in HTTP header
+    #
+    # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
+    def user_agent=(user_agent)
+      @user_agent = user_agent
+      @default_headers['User-Agent'] = @user_agent
+    end
+
+    # Return Accept header based on an array of accepts provided.
+    # @param [Array] accepts array for Accept
+    # @return [String] the Accept header (e.g. application/json)
+    def select_header_accept(accepts)
+      return nil if accepts.nil? || accepts.empty?
+      # use JSON when present, otherwise use all of the provided
+      json_accept = accepts.find { |s| json_mime?(s) }
+      json_accept || accepts.join(',')
+    end
+
+    # Return Content-Type header based on an array of content types provided.
+    # @param [Array] content_types array for Content-Type
+    # @return [String] the Content-Type header  (e.g. application/json)
+    def select_header_content_type(content_types)
+      # return nil by default
+      return if content_types.nil? || content_types.empty?
+      # use JSON when present, otherwise use the first one
+      json_content_type = content_types.find { |s| json_mime?(s) }
+      json_content_type || content_types.first
+    end
+
+    # Convert object (array, hash, object, etc) to JSON string.
+    # @param [Object] model object to be converted into JSON string
+    # @return [String] JSON string representation of the object
+    def object_to_http_body(model)
+      return model if model.nil? || model.is_a?(String)
+      local_body = nil
+      if model.is_a?(Array)
+        local_body = model.map { |m| object_to_hash(m) }
+      else
+        local_body = object_to_hash(model)
+      end
+      local_body.to_json
+    end
+
+    # Convert object(non-array) to hash.
+    # @param [Object] obj object to be converted into JSON string
+    # @return [String] JSON string representation of the object
+    def object_to_hash(obj)
+      if obj.respond_to?(:to_hash)
+        obj.to_hash
+      else
+        obj
+      end
+    end
+
+    # Build parameter value according to the given collection format.
+    # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
+    def build_collection_param(param, collection_format)
+      case collection_format
+      when :csv
+        param.join(',')
+      when :ssv
+        param.join(' ')
+      when :tsv
+        param.join("\t")
+      when :pipes
+        param.join('|')
+      when :multi
+        # return the array directly as typhoeus will handle it as expected
+        param
+      else
+        fail "unknown collection format: #{collection_format.inspect}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,122 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+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
+
+    attr_accessor :aftership_client
+
+    attr_accessor :headers
+  
+  
+    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 = {}
+
+      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) && (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
+  

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

@@ -0,0 +1,125 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+require 'json'
+
+module AftershipAPI
+  REQUEST_ERROR = 'REQUEST_ERROR'
+
+  # Common AfterShipError
+  INVALID_API_KEY = 'INVALID_API_KEY'.freeze
+  INVALID_OPTION = 'INVALID_OPTION'.freeze
+  RATE_LIMIT_EXCEEDED = 'RATE_LIMIT_EXCEEDED'.freeze
+  TIMED_OUT = "TIMED_OUT".freeze
+
+  INVALID_REQUEST = "INVALID_REQUEST".freeze
+  INVALID_JSON = "INVALID_JSON".freeze
+  TRACKING_ALREADY_EXIST = "TRACKING_ALREADY_EXIST".freeze
+  TRACKING_DOES_NOT_EXIST = "TRACKING_DOES_NOT_EXIST".freeze
+  TRACKING_NUMBER_INVALID = "TRACKING_NUMBER_INVALID".freeze
+  TRACKING_REQUIRED = "TRACKING_REQUIRED".freeze
+  TRACKING_NUMBER_REQUIRED = "TRACKING_NUMBER_REQUIRED".freeze
+  VALUE_INVALID = "VALUE_INVALID".freeze
+  VALUE_REQUIRED = "VALUE_REQUIRED".freeze
+  SLUG_INVALID = "SLUG_INVALID".freeze
+  MISSING_OR_INVALID_REQUIRED_FIELD = "MISSING_OR_INVALID_REQUIRED_FIELD".freeze
+  BAD_COURIER = "BAD_COURIER".freeze
+  INACTIVE_RETRACK_NOT_ALLOWED = "INACTIVE_RETRACK_NOT_ALLOWED".freeze
+  NOTIFICATION_REUQIRED = "NOTIFICATION_REUQIRED".freeze
+  ID_INVALID = "ID_INVALID".freeze
+  RETRACK_ONCE_ALLOWED = "RETRACK_ONCE_ALLOWED".freeze
+  TRACKING_NUMBER_FORMAT_INVALID = "TRACKING_NUMBER_FORMAT_INVALID".freeze
+  API_KEY_INVALID = "API_KEY_INVALID".freeze
+  REQUEST_NOT_ALLOWED = "REQUEST_NOT_ALLOWED".freeze
+  NOT_FOUND = "NOT_FOUND".freeze
+  TOO_MANY_REQUEST = "TOO_MANY_REQUEST".freeze
+  INTERNAL_ERROR = "INTERNAL_ERROR".freeze
+
+  ERROR_MAP = {
+    # Format: metaCode => ErrorCode
+    400 => INVALID_REQUEST,
+    4001 => INVALID_JSON,
+    4003 => TRACKING_ALREADY_EXIST,
+    4004 => TRACKING_DOES_NOT_EXIST,
+    4005 => TRACKING_NUMBER_INVALID,
+    4006 => TRACKING_REQUIRED,
+    4007 => TRACKING_NUMBER_REQUIRED,
+    4008 => VALUE_INVALID,
+    4009 => VALUE_REQUIRED,
+    4010 => SLUG_INVALID,
+    4011 => MISSING_OR_INVALID_REQUIRED_FIELD,
+    4012 => BAD_COURIER,
+    4013 => INACTIVE_RETRACK_NOT_ALLOWED,
+    4014 => NOTIFICATION_REUQIRED,
+    4015 => ID_INVALID,
+    4016 => RETRACK_ONCE_ALLOWED,
+    4017 => TRACKING_NUMBER_FORMAT_INVALID,
+    401 => API_KEY_INVALID,
+    403 => REQUEST_NOT_ALLOWED,
+    404 => NOT_FOUND,
+    429 => TOO_MANY_REQUEST,
+    500 => INTERNAL_ERROR,
+    502 => INTERNAL_ERROR,
+    503 => INTERNAL_ERROR,
+    504 => INTERNAL_ERROR,
+  }
+
+
+  class ApiError < StandardError
+    attr_reader :status_code, :response_headers, :response_body, :meta_code, :error_code
+
+    # Usage examples:
+    #   ApiError.new
+    #   ApiError.new("message")
+    #   ApiError.new(:status_code => 500, :response_headers => {}, :response_body => "")
+    #   ApiError.new(:status_code => 404, :message => "Not Found")
+    def initialize(arg = nil)
+      if arg.is_a? Hash
+        if arg.key?(:message) || arg.key?('message')
+          super(arg[:message] || arg['message'])
+        else
+          super arg
+        end
+
+        response_body = JSON.parse(arg[:response_body], :symbolize_names => true) rescue nil
+        @message = REQUEST_ERROR
+        if response_body && response_body[:meta] && response_body[:meta][:code]
+          @meta_code = response_body[:meta][:code]
+          @error_code = ERROR_MAP[@meta_code] || REQUEST_ERROR
+          @message = response_body[:meta][:message] || REQUEST_ERROR
+        end
+        arg.each do |k, v|
+          instance_variable_set "@#{k}", v
+        end
+      else
+        super arg
+        @message = arg
+      end
+    end
+
+    # Override to_s to display a friendly error message
+    def to_s
+      message
+    end
+
+    def message
+      if @message.nil?
+        msg = "Error message: the server returns an error"
+      else
+        msg = @message
+      end
+
+      msg += "\nHTTP status code: #{status_code}" if status_code
+      msg += "\nError Code #{error_code}" if error_code
+      msg += "\nResponse headers: #{response_headers}" if response_headers
+      msg += "\nResponse body: #{response_body}" if response_body
+
+      msg
+    end
+  end
+
+  class InvalidOptionError < StandardError
+  end
+
+  class InvalidParamError < StandardError
+  end
+end

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

@@ -0,0 +1,32 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+
+module AftershipAPI::Model
+  class AdditionalFieldsV1
+    TRACKING_ACCOUNT_NUMBER = "tracking_account_number".freeze
+    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_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
+    end
+
+    # Builds the enum from string
+    # @param value [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param value [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if AdditionalFieldsV1.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #AdditionalFieldsV1"
+    end
+  end
+end