apimatic-tql-sdk 0.0.1 → 0.0.2

data/lib/tql_otr_factoring_data_exchange/models/invoice_item_input.rb

@@ -1,165 +0,0 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-module TqlOtrFactoringDataExchange
-  # A physical line item on the invoice describing a commodity or handling unit
-  # being shipped. Items represent the freight itself — what was physically
-  # moved — as opposed to charges, which represent the monetary billing.
-  # Including item details enables freight audit and rate verification.
-  class InvoiceItemInput < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # Caller-assigned identifier for this item. Referenced by
-    # `ChargeInput.itemId` to link a charge to a specific item.
-    # @return [String]
-    attr_accessor :item_id
-
-    # Free-text description of the commodity or goods.
-    # @return [String]
-    attr_accessor :description
-
-    # Type of handling unit. Common values: Pallet, Drum, Bag, Barrels, Crates,
-    # Bundles, Pieces, Loose, Boxes, Cases, Carton, Totes.
-    # @return [String]
-    attr_accessor :handling_unit
-
-    # Number of handling units for this line item.
-    # @return [Integer]
-    attr_accessor :handling_unit_count
-
-    # Weight of this line item.
-    # @return [Float]
-    attr_accessor :weight
-
-    # Unit of measure for `weight`. Typically LBS or KG.
-    # @return [WeightUnit]
-    attr_accessor :weight_unit
-
-    # NMFC freight class (e.g., 50, 55, 60, 65, 70, 77.5, 85, 92.5, 100, 110,
-    # 125, 150, 175, 200, 250, 300, 400, 500). Used for LTL rating and audit.
-    # @return [Float]
-    attr_accessor :freight_class
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['item_id'] = 'itemId'
-      @_hash['description'] = 'description'
-      @_hash['handling_unit'] = 'handlingUnit'
-      @_hash['handling_unit_count'] = 'handlingUnitCount'
-      @_hash['weight'] = 'weight'
-      @_hash['weight_unit'] = 'weightUnit'
-      @_hash['freight_class'] = 'freightClass'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        description
-        handling_unit
-        handling_unit_count
-        weight
-        weight_unit
-        freight_class
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      %w[
-        description
-        handling_unit
-        handling_unit_count
-        weight
-        weight_unit
-        freight_class
-      ]
-    end
-
-    def initialize(item_id:, description: SKIP, handling_unit: SKIP,
-                   handling_unit_count: SKIP, weight: SKIP,
-                   weight_unit: WeightUnit::LBS, freight_class: SKIP,
-                   additional_properties: nil)
-      # Add additional model properties to the instance
-      additional_properties = {} if additional_properties.nil?
-
-      @item_id = item_id
-      @description = description unless description == SKIP
-      @handling_unit = handling_unit unless handling_unit == SKIP
-      @handling_unit_count = handling_unit_count unless handling_unit_count == SKIP
-      @weight = weight unless weight == SKIP
-      @weight_unit = weight_unit unless weight_unit == SKIP
-      @freight_class = freight_class unless freight_class == 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.
-      item_id = hash.key?('itemId') ? hash['itemId'] : nil
-      description = hash.key?('description') ? hash['description'] : SKIP
-      handling_unit = hash.key?('handlingUnit') ? hash['handlingUnit'] : SKIP
-      handling_unit_count =
-        hash.key?('handlingUnitCount') ? hash['handlingUnitCount'] : SKIP
-      weight = hash.key?('weight') ? hash['weight'] : SKIP
-      weight_unit = hash['weightUnit'] ||= WeightUnit::LBS
-      freight_class = hash.key?('freightClass') ? hash['freightClass'] : 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.
-      InvoiceItemInput.new(item_id: item_id,
-                           description: description,
-                           handling_unit: handling_unit,
-                           handling_unit_count: handling_unit_count,
-                           weight: weight,
-                           weight_unit: weight_unit,
-                           freight_class: freight_class,
-                           additional_properties: additional_properties)
-    end
-
-    # Validates an instance of the object from a given value.
-    # @param [InvoiceItemInput | Hash] The value against the validation is performed.
-    def self.validate(value)
-      if value.instance_of? self
-        return APIHelper.valid_type?(value.item_id,
-                                     ->(val) { val.instance_of? String })
-      end
-
-      return false unless value.instance_of? Hash
-
-      APIHelper.valid_type?(value['itemId'],
-                            ->(val) { val.instance_of? String })
-    end
-
-    # Provides a human-readable string representation of the object.
-    def to_s
-      class_name = self.class.name.split('::').last
-      "<#{class_name} item_id: #{@item_id}, description: #{@description}, handling_unit:"\
-      " #{@handling_unit}, handling_unit_count: #{@handling_unit_count}, weight: #{@weight},"\
-      " weight_unit: #{@weight_unit}, freight_class: #{@freight_class}, 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} item_id: #{@item_id.inspect}, description: #{@description.inspect},"\
-      " handling_unit: #{@handling_unit.inspect}, handling_unit_count:"\
-      " #{@handling_unit_count.inspect}, weight: #{@weight.inspect}, weight_unit:"\
-      " #{@weight_unit.inspect}, freight_class: #{@freight_class.inspect}, additional_properties:"\
-      " #{@additional_properties}>"
-    end
-  end
-end

data/lib/tql_otr_factoring_data_exchange/models/invoice_search_response.rb

@@ -1,124 +0,0 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-module TqlOtrFactoringDataExchange
-  # Paginated list of invoice search results.
-  class InvoiceSearchResponse < 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 invoices matching the search criteria.
-    # @return [Integer]
-    attr_accessor :total_count
-
-    # Total number of pages.
-    # @return [Integer]
-    attr_accessor :total_pages
-
-    # Invoices matching the search criteria for this page.
-    # @return [Array[Invoice]]
-    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 << (Invoice.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.
-      InvoiceSearchResponse.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/invoice_status.rb

@@ -1,74 +0,0 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-module TqlOtrFactoringDataExchange
-  # Processing and payment status of an invoice. The lifecycle typically flows:
-  # `Received` → `Validating` → `Processing` → `Approved` → `NotPaid` → `Paid`.
-  # Branches include `AwaitingDocuments`, `PendingExceptions`, and `Rejected`.
-  class InvoiceStatus
-    INVOICE_STATUS = [
-      # TODO: Write general description for RECEIVED
-      RECEIVED = 'Received'.freeze,
-
-      # TODO: Write general description for VALIDATING
-      VALIDATING = 'Validating'.freeze,
-
-      # TODO: Write general description for PROCESSING
-      PROCESSING = 'Processing'.freeze,
-
-      # TODO: Write general description for AWAITINGDOCUMENTS
-      AWAITINGDOCUMENTS = 'AwaitingDocuments'.freeze,
-
-      # TODO: Write general description for PENDINGEXCEPTIONS
-      PENDINGEXCEPTIONS = 'PendingExceptions'.freeze,
-
-      # TODO: Write general description for APPROVED
-      APPROVED = 'Approved'.freeze,
-
-      # TODO: Write general description for NOTPAID
-      NOTPAID = 'NotPaid'.freeze,
-
-      # TODO: Write general description for PAID
-      PAID = 'Paid'.freeze,
-
-      # TODO: Write general description for PARTIALLYPAID
-      PARTIALLYPAID = 'PartiallyPaid'.freeze,
-
-      # TODO: Write general description for COMPLETE
-      COMPLETE = 'Complete'.freeze,
-
-      # TODO: Write general description for REJECTED
-      REJECTED = 'Rejected'.freeze
-    ].freeze
-
-    def self.validate(value)
-      return false if value.nil?
-
-      INVOICE_STATUS.include?(value)
-    end
-
-    def self.from_value(value, default_value = RECEIVED)
-      return default_value if value.nil?
-
-      str = value.to_s.strip
-
-      case str.downcase
-      when 'received' then RECEIVED
-      when 'validating' then VALIDATING
-      when 'processing' then PROCESSING
-      when 'awaitingdocuments' then AWAITINGDOCUMENTS
-      when 'pendingexceptions' then PENDINGEXCEPTIONS
-      when 'approved' then APPROVED
-      when 'notpaid' then NOTPAID
-      when 'paid' then PAID
-      when 'partiallypaid' then PARTIALLYPAID
-      when 'complete' then COMPLETE
-      when 'rejected' then REJECTED
-      else
-        default_value
-      end
-    end
-  end
-end

data/lib/tql_otr_factoring_data_exchange/models/invoice_type.rb

@@ -1,50 +0,0 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-module TqlOtrFactoringDataExchange
-  # Indicates the purpose of the invoice being submitted. - **Invoice** — A
-  # standard carrier invoice for freight services   rendered on a load. This is
-  # the initial, primary billing   submitted by the factoring company on behalf
-  # of the carrier. - **BalanceDue** — A follow-up invoice for the remaining
-  # balance   after a partial payment or short-pay on a previously submitted
-  # invoice. Use this type when the original invoice was paid at   less than the
-  # full amount and the carrier is billing for the   difference. -
-  # **Supplemental** — An additional invoice for charges that were   not
-  # included on the original invoice. Common examples include   detention
-  # charges, lumper fees, or other accessorials   discovered or finalized after
-  # the initial invoice was   submitted.
-  class InvoiceType
-    INVOICE_TYPE = [
-      # TODO: Write general description for INVOICE
-      INVOICE = 'Invoice'.freeze,
-
-      # TODO: Write general description for BALANCEDUE
-      BALANCEDUE = 'BalanceDue'.freeze,
-
-      # TODO: Write general description for SUPPLEMENTAL
-      SUPPLEMENTAL = 'Supplemental'.freeze
-    ].freeze
-
-    def self.validate(value)
-      return false if value.nil?
-
-      INVOICE_TYPE.include?(value)
-    end
-
-    def self.from_value(value, default_value = INVOICE)
-      return default_value if value.nil?
-
-      str = value.to_s.strip
-
-      case str.downcase
-      when 'invoice' then INVOICE
-      when 'balancedue' then BALANCEDUE
-      when 'supplemental' then SUPPLEMENTAL
-      else
-        default_value
-      end
-    end
-  end
-end

data/lib/tql_otr_factoring_data_exchange/models/load_search_request.rb

@@ -1,205 +0,0 @@
-# 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