apimatic-tql-sdk 0.0.1

data/lib/tql_otr_factoring_data_exchange/models/invoice.rb

@@ -0,0 +1,223 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module TqlOtrFactoringDataExchange
+  # An invoice object. Properties are organized into logical groups:
+  # invoice-level fields at the top, with nested `carrier`, `load`, `payment`,
+  # and `documents` objects.
+  class Invoice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Direct URI to retrieve the full invoice status via GET.
+    # @return [String]
+    attr_accessor :uri
+
+    # The factoring company's invoice number.
+    # @return [String]
+    attr_accessor :invoice_number
+
+    # Name of the factoring company that submitted this invoice.
+    # @return [String]
+    attr_accessor :factoring_company_name
+
+    # Identifier of the factoring company, if provided during submission.
+    # @return [String]
+    attr_accessor :factoring_company_id
+
+    # Processing and payment status of an invoice. The lifecycle typically
+    # flows: `Received` → `Validating` → `Processing` → `Approved` → `NotPaid` →
+    # `Paid`. Branches include `AwaitingDocuments`, `PendingExceptions`, and
+    # `Rejected`.
+    # @return [InvoiceStatus]
+    attr_accessor :status
+
+    # UTC timestamp when the invoice was originally submitted.
+    # @return [DateTime]
+    attr_accessor :submitted_at
+
+    # UTC timestamp of the most recent update to this invoice.
+    # @return [DateTime]
+    attr_accessor :last_updated_at
+
+    # Whether a cargo claim has been filed against this invoice.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_claim
+
+    # Carrier details associated with this invoice.
+    # @return [Carrier]
+    attr_accessor :carrier
+
+    # TQL load details associated with this invoice.
+    # @return [Load]
+    attr_accessor :load
+
+    # Payment and billing details for this invoice.
+    # @return [Payment]
+    attr_accessor :payment
+
+    # List of documents associated with this invoice. Each entry includes the
+    # document ID and its document type.
+    # @return [Array[Document]]
+    attr_accessor :documents
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uri'] = 'uri'
+      @_hash['invoice_number'] = 'invoiceNumber'
+      @_hash['factoring_company_name'] = 'factoringCompanyName'
+      @_hash['factoring_company_id'] = 'factoringCompanyId'
+      @_hash['status'] = 'status'
+      @_hash['submitted_at'] = 'submittedAt'
+      @_hash['last_updated_at'] = 'lastUpdatedAt'
+      @_hash['has_claim'] = 'hasClaim'
+      @_hash['carrier'] = 'carrier'
+      @_hash['load'] = 'load'
+      @_hash['payment'] = 'payment'
+      @_hash['documents'] = 'documents'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uri
+        invoice_number
+        factoring_company_name
+        factoring_company_id
+        status
+        submitted_at
+        last_updated_at
+        has_claim
+        carrier
+        load
+        payment
+        documents
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        factoring_company_id
+      ]
+    end
+
+    def initialize(uri: SKIP, invoice_number: SKIP,
+                   factoring_company_name: SKIP, factoring_company_id: SKIP,
+                   status: SKIP, submitted_at: SKIP, last_updated_at: SKIP,
+                   has_claim: SKIP, carrier: SKIP, load: SKIP, payment: SKIP,
+                   documents: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @uri = uri unless uri == SKIP
+      @invoice_number = invoice_number unless invoice_number == SKIP
+      @factoring_company_name = factoring_company_name unless factoring_company_name == SKIP
+      @factoring_company_id = factoring_company_id unless factoring_company_id == SKIP
+      @status = status unless status == SKIP
+      @submitted_at = submitted_at unless submitted_at == SKIP
+      @last_updated_at = last_updated_at unless last_updated_at == SKIP
+      @has_claim = has_claim unless has_claim == SKIP
+      @carrier = carrier unless carrier == SKIP
+      @load = load unless load == SKIP
+      @payment = payment unless payment == SKIP
+      @documents = documents unless documents == 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.
+      uri = hash.key?('uri') ? hash['uri'] : SKIP
+      invoice_number = hash.key?('invoiceNumber') ? hash['invoiceNumber'] : SKIP
+      factoring_company_name =
+        hash.key?('factoringCompanyName') ? hash['factoringCompanyName'] : SKIP
+      factoring_company_id =
+        hash.key?('factoringCompanyId') ? hash['factoringCompanyId'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      submitted_at = if hash.key?('submittedAt')
+                       (DateTimeHelper.from_rfc3339(hash['submittedAt']) if hash['submittedAt'])
+                     else
+                       SKIP
+                     end
+      last_updated_at = if hash.key?('lastUpdatedAt')
+                          (DateTimeHelper.from_rfc3339(hash['lastUpdatedAt']) if hash['lastUpdatedAt'])
+                        else
+                          SKIP
+                        end
+      has_claim = hash.key?('hasClaim') ? hash['hasClaim'] : SKIP
+      carrier = Carrier.from_hash(hash['carrier']) if hash['carrier']
+      load = Load.from_hash(hash['load']) if hash['load']
+      payment = Payment.from_hash(hash['payment']) if hash['payment']
+      # Parameter is an array, so we need to iterate through it
+      documents = nil
+      unless hash['documents'].nil?
+        documents = []
+        hash['documents'].each do |structure|
+          documents << (Document.from_hash(structure) if structure)
+        end
+      end
+
+      documents = SKIP unless hash.key?('documents')
+
+      # 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.
+      Invoice.new(uri: uri,
+                  invoice_number: invoice_number,
+                  factoring_company_name: factoring_company_name,
+                  factoring_company_id: factoring_company_id,
+                  status: status,
+                  submitted_at: submitted_at,
+                  last_updated_at: last_updated_at,
+                  has_claim: has_claim,
+                  carrier: carrier,
+                  load: load,
+                  payment: payment,
+                  documents: documents,
+                  additional_properties: additional_properties)
+    end
+
+    def to_custom_submitted_at
+      DateTimeHelper.to_rfc3339(submitted_at)
+    end
+
+    def to_custom_last_updated_at
+      DateTimeHelper.to_rfc3339(last_updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} uri: #{@uri}, invoice_number: #{@invoice_number}, factoring_company_name:"\
+      " #{@factoring_company_name}, factoring_company_id: #{@factoring_company_id}, status:"\
+      " #{@status}, submitted_at: #{@submitted_at}, last_updated_at: #{@last_updated_at},"\
+      " has_claim: #{@has_claim}, carrier: #{@carrier}, load: #{@load}, payment: #{@payment},"\
+      " documents: #{@documents}, 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} uri: #{@uri.inspect}, invoice_number: #{@invoice_number.inspect},"\
+      " factoring_company_name: #{@factoring_company_name.inspect}, factoring_company_id:"\
+      " #{@factoring_company_id.inspect}, status: #{@status.inspect}, submitted_at:"\
+      " #{@submitted_at.inspect}, last_updated_at: #{@last_updated_at.inspect}, has_claim:"\
+      " #{@has_claim.inspect}, carrier: #{@carrier.inspect}, load: #{@load.inspect}, payment:"\
+      " #{@payment.inspect}, documents: #{@documents.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/invoice_exception.rb

@@ -0,0 +1,136 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module TqlOtrFactoringDataExchange
+  # A processing exception or discrepancy found during invoice validation.
+  class InvoiceException < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for this exception.
+    # @return [UUID | String]
+    attr_accessor :exception_id
+
+    # Machine-readable exception code.
+    # @return [String]
+    attr_accessor :code
+
+    # Severity level of a processing exception.
+    # @return [ExceptionSeverity]
+    attr_accessor :severity
+
+    # Human-readable description of the exception.
+    # @return [String]
+    attr_accessor :message
+
+    # The field or area that triggered the exception, if applicable.
+    # @return [String]
+    attr_accessor :field
+
+    # When the exception was identified.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['exception_id'] = 'exceptionId'
+      @_hash['code'] = 'code'
+      @_hash['severity'] = 'severity'
+      @_hash['message'] = 'message'
+      @_hash['field'] = 'field'
+      @_hash['created_at'] = 'createdAt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        exception_id
+        code
+        severity
+        message
+        field
+        created_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        field
+      ]
+    end
+
+    def initialize(exception_id: SKIP, code: SKIP, severity: SKIP,
+                   message: SKIP, field: SKIP, created_at: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @exception_id = exception_id unless exception_id == SKIP
+      @code = code unless code == SKIP
+      @severity = severity unless severity == SKIP
+      @message = message unless message == SKIP
+      @field = field unless field == SKIP
+      @created_at = created_at unless created_at == 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.
+      exception_id = hash.key?('exceptionId') ? hash['exceptionId'] : SKIP
+      code = hash.key?('code') ? hash['code'] : SKIP
+      severity = hash.key?('severity') ? hash['severity'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+      field = hash.key?('field') ? hash['field'] : SKIP
+      created_at = if hash.key?('createdAt')
+                     (DateTimeHelper.from_rfc3339(hash['createdAt']) if hash['createdAt'])
+                   else
+                     SKIP
+                   end
+
+      # 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.
+      InvoiceException.new(exception_id: exception_id,
+                           code: code,
+                           severity: severity,
+                           message: message,
+                           field: field,
+                           created_at: created_at,
+                           additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} exception_id: #{@exception_id}, code: #{@code}, severity: #{@severity},"\
+      " message: #{@message}, field: #{@field}, created_at: #{@created_at}, 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} exception_id: #{@exception_id.inspect}, code: #{@code.inspect}, severity:"\
+      " #{@severity.inspect}, message: #{@message.inspect}, field: #{@field.inspect}, created_at:"\
+      " #{@created_at.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/invoice_item_input.rb

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