apimatic-tql-sdk 0.0.1

data/lib/tql_otr_factoring_data_exchange/models/load.rb

@@ -0,0 +1,110 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # TQL load details associated with this invoice.
+  class Load < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The TQL load number.
+    # @return [String]
+    attr_accessor :load_number
+
+    # Current status of the underlying TQL load.
+    # @return [String]
+    attr_accessor :status
+
+    # Date the load was picked up.
+    # @return [Date]
+    attr_accessor :pickup_date
+
+    # Date the load was delivered.
+    # @return [Date]
+    attr_accessor :delivery_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['load_number'] = 'loadNumber'
+      @_hash['status'] = 'status'
+      @_hash['pickup_date'] = 'pickupDate'
+      @_hash['delivery_date'] = 'deliveryDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        load_number
+        status
+        pickup_date
+        delivery_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        status
+        pickup_date
+        delivery_date
+      ]
+    end
+
+    def initialize(load_number: SKIP, status: SKIP, pickup_date: SKIP,
+                   delivery_date: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @load_number = load_number unless load_number == SKIP
+      @status = status unless status == SKIP
+      @pickup_date = pickup_date unless pickup_date == SKIP
+      @delivery_date = delivery_date unless delivery_date == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      load_number = hash.key?('loadNumber') ? hash['loadNumber'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      pickup_date = hash.key?('pickupDate') ? hash['pickupDate'] : SKIP
+      delivery_date = hash.key?('deliveryDate') ? hash['deliveryDate'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Load.new(load_number: load_number,
+               status: status,
+               pickup_date: pickup_date,
+               delivery_date: delivery_date,
+               additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} load_number: #{@load_number}, status: #{@status}, pickup_date:"\
+      " #{@pickup_date}, delivery_date: #{@delivery_date}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} load_number: #{@load_number.inspect}, status: #{@status.inspect},"\
+      " pickup_date: #{@pickup_date.inspect}, delivery_date: #{@delivery_date.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/load_detail.rb

@@ -0,0 +1,140 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Basic details of a TQL load.
+  class LoadDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The TQL load number.
+    # @return [String]
+    attr_accessor :load_number
+
+    # Carrier's PRO (progressive) number, if available.
+    # @return [String]
+    attr_accessor :pro_number
+
+    # Bill of Lading number, if available.
+    # @return [String]
+    attr_accessor :bol_number
+
+    # Current status of a TQL load.
+    # @return [LoadStatus]
+    attr_accessor :status
+
+    # Carrier assigned to this load.
+    # @return [Carrier2]
+    attr_accessor :carrier
+
+    # Date the load was (or is scheduled to be) picked up.
+    # @return [Date]
+    attr_accessor :ship_date
+
+    # Date the load was (or is scheduled to be) delivered.
+    # @return [Date]
+    attr_accessor :delivery_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['load_number'] = 'loadNumber'
+      @_hash['pro_number'] = 'proNumber'
+      @_hash['bol_number'] = 'bolNumber'
+      @_hash['status'] = 'status'
+      @_hash['carrier'] = 'carrier'
+      @_hash['ship_date'] = 'shipDate'
+      @_hash['delivery_date'] = 'deliveryDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        load_number
+        pro_number
+        bol_number
+        status
+        carrier
+        ship_date
+        delivery_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        pro_number
+        bol_number
+        ship_date
+        delivery_date
+      ]
+    end
+
+    def initialize(load_number: SKIP, pro_number: SKIP, bol_number: SKIP,
+                   status: SKIP, carrier: SKIP, ship_date: SKIP,
+                   delivery_date: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @load_number = load_number unless load_number == SKIP
+      @pro_number = pro_number unless pro_number == SKIP
+      @bol_number = bol_number unless bol_number == SKIP
+      @status = status unless status == SKIP
+      @carrier = carrier unless carrier == SKIP
+      @ship_date = ship_date unless ship_date == SKIP
+      @delivery_date = delivery_date unless delivery_date == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      load_number = hash.key?('loadNumber') ? hash['loadNumber'] : SKIP
+      pro_number = hash.key?('proNumber') ? hash['proNumber'] : SKIP
+      bol_number = hash.key?('bolNumber') ? hash['bolNumber'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      carrier = Carrier2.from_hash(hash['carrier']) if hash['carrier']
+      ship_date = hash.key?('shipDate') ? hash['shipDate'] : SKIP
+      delivery_date = hash.key?('deliveryDate') ? hash['deliveryDate'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      LoadDetail.new(load_number: load_number,
+                     pro_number: pro_number,
+                     bol_number: bol_number,
+                     status: status,
+                     carrier: carrier,
+                     ship_date: ship_date,
+                     delivery_date: delivery_date,
+                     additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} load_number: #{@load_number}, pro_number: #{@pro_number}, bol_number:"\
+      " #{@bol_number}, status: #{@status}, carrier: #{@carrier}, ship_date: #{@ship_date},"\
+      " delivery_date: #{@delivery_date}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} load_number: #{@load_number.inspect}, pro_number: #{@pro_number.inspect},"\
+      " bol_number: #{@bol_number.inspect}, status: #{@status.inspect}, carrier:"\
+      " #{@carrier.inspect}, ship_date: #{@ship_date.inspect}, delivery_date:"\
+      " #{@delivery_date.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/load_search_request.rb

@@ -0,0 +1,205 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Search filters and pagination for querying TQL loads. All filter fields are
+  # optional.
+  class LoadSearchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 1-based page number.
+    # @return [Integer]
+    attr_accessor :page
+
+    # Number of results per page (max 100).
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # Filter by one or more TQL load numbers (exact match).
+    # @return [Array[String]]
+    attr_accessor :load_numbers
+
+    # Filter by one or more carrier PRO numbers (exact match).
+    # @return [Array[String]]
+    attr_accessor :pro_numbers
+
+    # Filter by one or more Bill of Lading numbers (exact match).
+    # @return [Array[String]]
+    attr_accessor :bol_numbers
+
+    # Filter by one or more load statuses (OR within the array).
+    # @return [Array[LoadStatus]]
+    attr_accessor :statuses
+
+    # Filter by one or more USDOT numbers (exact match).
+    # @return [Array[String]]
+    attr_accessor :carrier_dot_numbers
+
+    # Filter by one or more MC numbers (exact match).
+    # @return [Array[String]]
+    attr_accessor :carrier_mc_numbers
+
+    # Only return loads with a ship date on or after this date.
+    # @return [Date]
+    attr_accessor :ship_date_after
+
+    # Only return loads with a ship date before this date.
+    # @return [Date]
+    attr_accessor :ship_date_before
+
+    # Only return loads with a delivery date on or after this date.
+    # @return [Date]
+    attr_accessor :delivery_date_after
+
+    # Only return loads with a delivery date before this date.
+    # @return [Date]
+    attr_accessor :delivery_date_before
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['page_size'] = 'pageSize'
+      @_hash['load_numbers'] = 'loadNumbers'
+      @_hash['pro_numbers'] = 'proNumbers'
+      @_hash['bol_numbers'] = 'bolNumbers'
+      @_hash['statuses'] = 'statuses'
+      @_hash['carrier_dot_numbers'] = 'carrierDotNumbers'
+      @_hash['carrier_mc_numbers'] = 'carrierMcNumbers'
+      @_hash['ship_date_after'] = 'shipDateAfter'
+      @_hash['ship_date_before'] = 'shipDateBefore'
+      @_hash['delivery_date_after'] = 'deliveryDateAfter'
+      @_hash['delivery_date_before'] = 'deliveryDateBefore'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        load_numbers
+        pro_numbers
+        bol_numbers
+        statuses
+        carrier_dot_numbers
+        carrier_mc_numbers
+        ship_date_after
+        ship_date_before
+        delivery_date_after
+        delivery_date_before
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        load_numbers
+        pro_numbers
+        bol_numbers
+        statuses
+        carrier_dot_numbers
+        carrier_mc_numbers
+        ship_date_after
+        ship_date_before
+        delivery_date_after
+        delivery_date_before
+      ]
+    end
+
+    def initialize(page:, page_size:, load_numbers: SKIP, pro_numbers: SKIP,
+                   bol_numbers: SKIP, statuses: SKIP, carrier_dot_numbers: SKIP,
+                   carrier_mc_numbers: SKIP, ship_date_after: SKIP,
+                   ship_date_before: SKIP, delivery_date_after: SKIP,
+                   delivery_date_before: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page
+      @page_size = page_size
+      @load_numbers = load_numbers unless load_numbers == SKIP
+      @pro_numbers = pro_numbers unless pro_numbers == SKIP
+      @bol_numbers = bol_numbers unless bol_numbers == SKIP
+      @statuses = statuses unless statuses == SKIP
+      @carrier_dot_numbers = carrier_dot_numbers unless carrier_dot_numbers == SKIP
+      @carrier_mc_numbers = carrier_mc_numbers unless carrier_mc_numbers == SKIP
+      @ship_date_after = ship_date_after unless ship_date_after == SKIP
+      @ship_date_before = ship_date_before unless ship_date_before == SKIP
+      @delivery_date_after = delivery_date_after unless delivery_date_after == SKIP
+      @delivery_date_before = delivery_date_before unless delivery_date_before == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      page = hash.key?('page') ? hash['page'] : nil
+      page_size = hash.key?('pageSize') ? hash['pageSize'] : nil
+      load_numbers = hash.key?('loadNumbers') ? hash['loadNumbers'] : SKIP
+      pro_numbers = hash.key?('proNumbers') ? hash['proNumbers'] : SKIP
+      bol_numbers = hash.key?('bolNumbers') ? hash['bolNumbers'] : SKIP
+      statuses = hash.key?('statuses') ? hash['statuses'] : SKIP
+      carrier_dot_numbers =
+        hash.key?('carrierDotNumbers') ? hash['carrierDotNumbers'] : SKIP
+      carrier_mc_numbers =
+        hash.key?('carrierMcNumbers') ? hash['carrierMcNumbers'] : SKIP
+      ship_date_after =
+        hash.key?('shipDateAfter') ? hash['shipDateAfter'] : SKIP
+      ship_date_before =
+        hash.key?('shipDateBefore') ? hash['shipDateBefore'] : SKIP
+      delivery_date_after =
+        hash.key?('deliveryDateAfter') ? hash['deliveryDateAfter'] : SKIP
+      delivery_date_before =
+        hash.key?('deliveryDateBefore') ? hash['deliveryDateBefore'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      LoadSearchRequest.new(page: page,
+                            page_size: page_size,
+                            load_numbers: load_numbers,
+                            pro_numbers: pro_numbers,
+                            bol_numbers: bol_numbers,
+                            statuses: statuses,
+                            carrier_dot_numbers: carrier_dot_numbers,
+                            carrier_mc_numbers: carrier_mc_numbers,
+                            ship_date_after: ship_date_after,
+                            ship_date_before: ship_date_before,
+                            delivery_date_after: delivery_date_after,
+                            delivery_date_before: delivery_date_before,
+                            additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page: #{@page}, page_size: #{@page_size}, load_numbers: #{@load_numbers},"\
+      " pro_numbers: #{@pro_numbers}, bol_numbers: #{@bol_numbers}, statuses: #{@statuses},"\
+      " carrier_dot_numbers: #{@carrier_dot_numbers}, carrier_mc_numbers: #{@carrier_mc_numbers},"\
+      " ship_date_after: #{@ship_date_after}, ship_date_before: #{@ship_date_before},"\
+      " delivery_date_after: #{@delivery_date_after}, delivery_date_before:"\
+      " #{@delivery_date_before}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page: #{@page.inspect}, page_size: #{@page_size.inspect}, load_numbers:"\
+      " #{@load_numbers.inspect}, pro_numbers: #{@pro_numbers.inspect}, bol_numbers:"\
+      " #{@bol_numbers.inspect}, statuses: #{@statuses.inspect}, carrier_dot_numbers:"\
+      " #{@carrier_dot_numbers.inspect}, carrier_mc_numbers: #{@carrier_mc_numbers.inspect},"\
+      " ship_date_after: #{@ship_date_after.inspect}, ship_date_before:"\
+      " #{@ship_date_before.inspect}, delivery_date_after: #{@delivery_date_after.inspect},"\
+      " delivery_date_before: #{@delivery_date_before.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/load_search_response.rb

@@ -0,0 +1,124 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Paginated list of load search results.
+  class LoadSearchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Current page number.
+    # @return [Integer]
+    attr_accessor :page
+
+    # Number of results per page.
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # Total number of loads matching the search criteria.
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # Total number of pages.
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # Loads matching the search criteria for this page.
+    # @return [Array[LoadDetail]]
+    attr_accessor :results
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['page_size'] = 'pageSize'
+      @_hash['total_count'] = 'totalCount'
+      @_hash['total_pages'] = 'totalPages'
+      @_hash['results'] = 'results'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        page_size
+        total_count
+        total_pages
+        results
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, page_size: SKIP, total_count: SKIP,
+                   total_pages: SKIP, results: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page unless page == SKIP
+      @page_size = page_size unless page_size == SKIP
+      @total_count = total_count unless total_count == SKIP
+      @total_pages = total_pages unless total_pages == SKIP
+      @results = results unless results == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      page = hash.key?('page') ? hash['page'] : SKIP
+      page_size = hash.key?('pageSize') ? hash['pageSize'] : SKIP
+      total_count = hash.key?('totalCount') ? hash['totalCount'] : SKIP
+      total_pages = hash.key?('totalPages') ? hash['totalPages'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      results = nil
+      unless hash['results'].nil?
+        results = []
+        hash['results'].each do |structure|
+          results << (LoadDetail.from_hash(structure) if structure)
+        end
+      end
+
+      results = SKIP unless hash.key?('results')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      LoadSearchResponse.new(page: page,
+                             page_size: page_size,
+                             total_count: total_count,
+                             total_pages: total_pages,
+                             results: results,
+                             additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page: #{@page}, page_size: #{@page_size}, total_count: #{@total_count},"\
+      " total_pages: #{@total_pages}, results: #{@results}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page: #{@page.inspect}, page_size: #{@page_size.inspect}, total_count:"\
+      " #{@total_count.inspect}, total_pages: #{@total_pages.inspect}, results:"\
+      " #{@results.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/load_status.rb

@@ -0,0 +1,56 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Current status of a TQL load.
+  class LoadStatus
+    LOAD_STATUS = [
+      # TODO: Write general description for AVAILABLE
+      AVAILABLE = 'Available'.freeze,
+
+      # TODO: Write general description for BOOKED
+      BOOKED = 'Booked'.freeze,
+
+      # TODO: Write general description for DISPATCHED
+      DISPATCHED = 'Dispatched'.freeze,
+
+      # TODO: Write general description for INTRANSIT
+      INTRANSIT = 'InTransit'.freeze,
+
+      # TODO: Write general description for DELIVERED
+      DELIVERED = 'Delivered'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'Completed'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'Cancelled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LOAD_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = AVAILABLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'available' then AVAILABLE
+      when 'booked' then BOOKED
+      when 'dispatched' then DISPATCHED
+      when 'intransit' then INTRANSIT
+      when 'delivered' then DELIVERED
+      when 'completed' then COMPLETED
+      when 'cancelled' then CANCELLED
+      else
+        default_value
+      end
+    end
+  end
+end