apimatic-tql-sdk 0.0.1

data/lib/tql_otr_factoring_data_exchange/models/reference_type.rb

@@ -0,0 +1,90 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Reference number qualifier. Values follow [EDI
+  # 210](https://www.stedi.com/edi/x12/transaction-set/210) / [ANSI
+  # X12](https://www.x12.org/) Reference Identification Qualifier codes.
+  class ReferenceType
+    REFERENCE_TYPE = [
+      # TODO: Write general description for BM
+      BM = 'BM'.freeze,
+
+      # TODO: Write general description for PO
+      PO = 'PO'.freeze,
+
+      # TODO: Write general description for PRO
+      PRO = 'PRO'.freeze,
+
+      # TODO: Write general description for SI
+      SI = 'SI'.freeze,
+
+      # TODO: Write general description for CN
+      CN = 'CN'.freeze,
+
+      # TODO: Write general description for CR
+      CR = 'CR'.freeze,
+
+      # TODO: Write general description for AO
+      AO = 'AO'.freeze,
+
+      # TODO: Write general description for MB
+      MB = 'MB'.freeze,
+
+      # TODO: Write general description for TN
+      TN = 'TN'.freeze,
+
+      # TODO: Write general description for IV
+      IV = 'IV'.freeze,
+
+      # TODO: Write general description for SN
+      SN = 'SN'.freeze,
+
+      # TODO: Write general description for LO
+      LO = 'LO'.freeze,
+
+      # TODO: Write general description for DO
+      DO = 'DO'.freeze,
+
+      # TODO: Write general description for CO
+      CO = 'CO'.freeze,
+
+      # TODO: Write general description for TL
+      TL = 'TL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REFERENCE_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = BM)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'bm' then BM
+      when 'po' then PO
+      when 'pro' then PRO
+      when 'si' then SI
+      when 'cn' then CN
+      when 'cr' then CR
+      when 'ao' then AO
+      when 'mb' then MB
+      when 'tn' then TN
+      when 'iv' then IV
+      when 'sn' then SN
+      when 'lo' then LO
+      when 'do' then DO
+      when 'co' then CO
+      when 'tl' then TL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/status.rb

@@ -0,0 +1,44 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Processing status of this document.
+  class Status
+    STATUS = [
+      # TODO: Write general description for RECEIVED
+      RECEIVED = 'Received'.freeze,
+
+      # TODO: Write general description for EXTRACTING
+      EXTRACTING = 'Extracting'.freeze,
+
+      # TODO: Write general description for COMPLETE
+      COMPLETE = 'Complete'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'Failed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      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 'extracting' then EXTRACTING
+      when 'complete' then COMPLETE
+      when 'failed' then FAILED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/stop_input.rb

@@ -0,0 +1,121 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # A pickup or delivery stop on the shipment route, using [EDI
+  # 210](https://www.stedi.com/edi/x12/transaction-set/210) stop type codes.
+  class StopInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of stop. Values align with [EDI
+    # 210](https://www.stedi.com/edi/x12/transaction-set/210) stop-off detail
+    # codes.
+    # @return [StopType]
+    attr_accessor :stop_type
+
+    # 1-based ordering of the stop in the route.
+    # @return [Integer]
+    attr_accessor :sequence
+
+    # Physical address of the stop.
+    # @return [Location]
+    attr_accessor :location
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['stop_type'] = 'stopType'
+      @_hash['sequence'] = 'sequence'
+      @_hash['location'] = 'location'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(stop_type:, sequence:, location:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @stop_type = stop_type
+      @sequence = sequence
+      @location = location
+      @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.
+      stop_type = hash.key?('stopType') ? hash['stopType'] : nil
+      sequence = hash.key?('sequence') ? hash['sequence'] : nil
+      location = Location.from_hash(hash['location']) if hash['location']
+
+      # 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.
+      StopInput.new(stop_type: stop_type,
+                    sequence: sequence,
+                    location: location,
+                    additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [StopInput | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.stop_type,
+                                ->(val) { StopType.validate(val) }) and
+            APIHelper.valid_type?(value.sequence,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.location,
+                                  ->(val) { Location.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['stopType'],
+                              ->(val) { StopType.validate(val) }) and
+          APIHelper.valid_type?(value['sequence'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['location'],
+                                ->(val) { Location.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} stop_type: #{@stop_type}, sequence: #{@sequence}, location: #{@location},"\
+      " 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} stop_type: #{@stop_type.inspect}, sequence: #{@sequence.inspect}, location:"\
+      " #{@location.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/stop_type.rb

@@ -0,0 +1,62 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Type of stop. Values align with [EDI
+  # 210](https://www.stedi.com/edi/x12/transaction-set/210) stop-off detail
+  # codes.
+  class StopType
+    STOP_TYPE = [
+      # TODO: Write general description for PU
+      PU = 'PU'.freeze,
+
+      # TODO: Write general description for DL
+      DL = 'DL'.freeze,
+
+      # TODO: Write general description for CL
+      CL = 'CL'.freeze,
+
+      # TODO: Write general description for PL
+      PL = 'PL'.freeze,
+
+      # TODO: Write general description for UL
+      UL = 'UL'.freeze,
+
+      # TODO: Write general description for CS
+      CS = 'CS'.freeze,
+
+      # TODO: Write general description for DS
+      DS = 'DS'.freeze,
+
+      # TODO: Write general description for XX
+      XX = 'XX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STOP_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = PU)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pu' then PU
+      when 'dl' then DL
+      when 'cl' then CL
+      when 'pl' then PL
+      when 'ul' then UL
+      when 'cs' then CS
+      when 'ds' then DS
+      when 'xx' then XX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/submit_invoice_request.rb

@@ -0,0 +1,326 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Factoring company invoice submitted against a TQL load. Documents should be
+  # uploaded separately via `POST /api/documents`.
+  class SubmitInvoiceRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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.
+    # @return [InvoiceType]
+    attr_accessor :type
+
+    # The TQL load number this invoice is billed against. This is the load
+    # identifier assigned by TQL and must match an existing load in the TQL
+    # system.
+    # @return [String]
+    attr_accessor :load_number
+
+    # The factoring company's invoice number for this shipment. This is the
+    # primary identifier the factoring company uses to track this invoice.
+    # @return [String]
+    attr_accessor :invoice_number
+
+    # The carrier's own invoice number, if different from the factoring
+    # company's invoice number. Optional.
+    # @return [String]
+    attr_accessor :carrier_invoice_number
+
+    # Carrier information for the invoiced shipment. At least one of `mcNumber`
+    # or `dotNumber` must be provided.
+    # @return [Object]
+    attr_accessor :carrier
+
+    # Identifies the factoring company that purchased (bought out) the carrier's
+    # loads.
+    # @return [FactoringCompanyInput]
+    attr_accessor :factoring_company
+
+    # Ordered list of stops for the invoiced shipment. Must include at least an
+    # origin and a destination.
+    # @return [Array[StopInput]]
+    attr_accessor :stops
+
+    # One or more carrier charge line items on this invoice.
+    # @return [Array[ChargeInput]]
+    attr_accessor :charges
+
+    # Physical line items describing the freight being shipped. Each item
+    # represents a distinct commodity or handling unit on the load — for
+    # example, 4 pallets of paper towels at 2,310 lbs, freight class 100. Items
+    # describe **what was moved**; charges describe **what you are billing**.
+    # These are independent concepts — charges are not linked to specific items.
+    # @return [Array[InvoiceItemInput]]
+    attr_accessor :items
+
+    # One or more reference numbers (PRO, PO, BOL, etc.) to cross-reference this
+    # invoice with the TQL load.
+    # @return [Array[ReferenceNumberInput]]
+    attr_accessor :reference_numbers
+
+    # Date the invoice was generated or sent by the factoring company. [ISO
+    # 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date format
+    # (YYYY-MM-DD).
+    # @return [Date]
+    attr_accessor :invoice_date
+
+    # Date by which the invoice should be paid, if known. [ISO
+    # 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date format
+    # (YYYY-MM-DD).
+    # @return [Date]
+    attr_accessor :invoice_due_date
+
+    # Invoice payment terms. Use `NetN` where N is the number of days until
+    # payment is due (0–365), or `Prepaid` for invoices paid in advance.
+    # @return [String]
+    attr_accessor :payment_terms
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['load_number'] = 'loadNumber'
+      @_hash['invoice_number'] = 'invoiceNumber'
+      @_hash['carrier_invoice_number'] = 'carrierInvoiceNumber'
+      @_hash['carrier'] = 'carrier'
+      @_hash['factoring_company'] = 'factoringCompany'
+      @_hash['stops'] = 'stops'
+      @_hash['charges'] = 'charges'
+      @_hash['items'] = 'items'
+      @_hash['reference_numbers'] = 'referenceNumbers'
+      @_hash['invoice_date'] = 'invoiceDate'
+      @_hash['invoice_due_date'] = 'invoiceDueDate'
+      @_hash['payment_terms'] = 'paymentTerms'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        carrier_invoice_number
+        items
+        invoice_due_date
+        payment_terms
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        carrier_invoice_number
+        items
+        invoice_due_date
+        payment_terms
+      ]
+    end
+
+    def initialize(load_number:, invoice_number:, carrier:, factoring_company:,
+                   stops:, charges:, reference_numbers:, invoice_date:,
+                   type: InvoiceType::INVOICE, carrier_invoice_number: SKIP,
+                   items: SKIP, invoice_due_date: SKIP, payment_terms: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @type = type unless type == SKIP
+      @load_number = load_number
+      @invoice_number = invoice_number
+      @carrier_invoice_number = carrier_invoice_number unless carrier_invoice_number == SKIP
+      @carrier = carrier
+      @factoring_company = factoring_company
+      @stops = stops
+      @charges = charges
+      @items = items unless items == SKIP
+      @reference_numbers = reference_numbers
+      @invoice_date = invoice_date
+      @invoice_due_date = invoice_due_date unless invoice_due_date == SKIP
+      @payment_terms = payment_terms unless payment_terms == 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'] : nil
+      invoice_number = hash.key?('invoiceNumber') ? hash['invoiceNumber'] : nil
+      carrier = hash.key?('carrier') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CarrierInput2), hash['carrier']
+      ) : nil
+      factoring_company = FactoringCompanyInput.from_hash(hash['factoringCompany']) if
+        hash['factoringCompany']
+      # Parameter is an array, so we need to iterate through it
+      stops = nil
+      unless hash['stops'].nil?
+        stops = []
+        hash['stops'].each do |structure|
+          stops << (StopInput.from_hash(structure) if structure)
+        end
+      end
+
+      stops = nil unless hash.key?('stops')
+      # Parameter is an array, so we need to iterate through it
+      charges = nil
+      unless hash['charges'].nil?
+        charges = []
+        hash['charges'].each do |structure|
+          charges << (ChargeInput.from_hash(structure) if structure)
+        end
+      end
+
+      charges = nil unless hash.key?('charges')
+      # Parameter is an array, so we need to iterate through it
+      reference_numbers = nil
+      unless hash['referenceNumbers'].nil?
+        reference_numbers = []
+        hash['referenceNumbers'].each do |structure|
+          reference_numbers << (ReferenceNumberInput.from_hash(structure) if structure)
+        end
+      end
+
+      reference_numbers = nil unless hash.key?('referenceNumbers')
+      invoice_date = hash.key?('invoiceDate') ? hash['invoiceDate'] : nil
+      type = hash['type'] ||= InvoiceType::INVOICE
+      carrier_invoice_number =
+        hash.key?('carrierInvoiceNumber') ? hash['carrierInvoiceNumber'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (InvoiceItemInput.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+      invoice_due_date =
+        hash.key?('invoiceDueDate') ? hash['invoiceDueDate'] : SKIP
+      payment_terms = hash.key?('paymentTerms') ? hash['paymentTerms'] : 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.
+      SubmitInvoiceRequest.new(load_number: load_number,
+                               invoice_number: invoice_number,
+                               carrier: carrier,
+                               factoring_company: factoring_company,
+                               stops: stops,
+                               charges: charges,
+                               reference_numbers: reference_numbers,
+                               invoice_date: invoice_date,
+                               type: type,
+                               carrier_invoice_number: carrier_invoice_number,
+                               items: items,
+                               invoice_due_date: invoice_due_date,
+                               payment_terms: payment_terms,
+                               additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SubmitInvoiceRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.load_number,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.invoice_number,
+                                  ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:CarrierInput2)
+                           .validate(value.carrier) and
+            APIHelper.valid_type?(value.factoring_company,
+                                  ->(val) { FactoringCompanyInput.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.stops,
+                                  ->(val) { StopInput.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.charges,
+                                  ->(val) { ChargeInput.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.reference_numbers,
+                                  ->(val) { ReferenceNumberInput.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.invoice_date,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['loadNumber'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['invoiceNumber'],
+                                ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:CarrierInput2)
+                         .validate(value['carrier']) and
+          APIHelper.valid_type?(value['factoringCompany'],
+                                ->(val) { FactoringCompanyInput.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['stops'],
+                                ->(val) { StopInput.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['charges'],
+                                ->(val) { ChargeInput.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['referenceNumbers'],
+                                ->(val) { ReferenceNumberInput.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['invoiceDate'],
+                                ->(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} type: #{@type}, load_number: #{@load_number}, invoice_number:"\
+      " #{@invoice_number}, carrier_invoice_number: #{@carrier_invoice_number}, carrier:"\
+      " #{@carrier}, factoring_company: #{@factoring_company}, stops: #{@stops}, charges:"\
+      " #{@charges}, items: #{@items}, reference_numbers: #{@reference_numbers}, invoice_date:"\
+      " #{@invoice_date}, invoice_due_date: #{@invoice_due_date}, payment_terms:"\
+      " #{@payment_terms}, 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} type: #{@type.inspect}, load_number: #{@load_number.inspect},"\
+      " invoice_number: #{@invoice_number.inspect}, carrier_invoice_number:"\
+      " #{@carrier_invoice_number.inspect}, carrier: #{@carrier.inspect}, factoring_company:"\
+      " #{@factoring_company.inspect}, stops: #{@stops.inspect}, charges: #{@charges.inspect},"\
+      " items: #{@items.inspect}, reference_numbers: #{@reference_numbers.inspect}, invoice_date:"\
+      " #{@invoice_date.inspect}, invoice_due_date: #{@invoice_due_date.inspect}, payment_terms:"\
+      " #{@payment_terms.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end