apimatic-tql-sdk 0.0.1

data/lib/tql_otr_factoring_data_exchange/models/carrier_input1.rb

@@ -0,0 +1,123 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # CarrierInput1 Model.
+  class CarrierInput1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Legal or DBA name of the carrier.
+    # @return [String]
+    attr_accessor :carrier_name
+
+    # Motor Carrier (MC) number issued by [FMCSA](https://www.fmcsa.dot.gov/).
+    # @return [String]
+    attr_accessor :mc_number
+
+    # USDOT number issued by [FMCSA](https://www.fmcsa.dot.gov/).
+    # @return [String]
+    attr_accessor :dot_number
+
+    # Standard Carrier Alpha Code
+    # ([SCAC](https://nmfta.org/registration-listing/scac/)).
+    # @return [String]
+    attr_accessor :scac
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier_name'] = 'carrierName'
+      @_hash['mc_number'] = 'mcNumber'
+      @_hash['dot_number'] = 'dotNumber'
+      @_hash['scac'] = 'scac'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier_name
+        mc_number
+        scac
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        mc_number
+        dot_number
+        scac
+      ]
+    end
+
+    def initialize(dot_number:, carrier_name: SKIP, mc_number: SKIP, scac: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @carrier_name = carrier_name unless carrier_name == SKIP
+      @mc_number = mc_number unless mc_number == SKIP
+      @dot_number = dot_number
+      @scac = scac unless scac == 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.
+      dot_number = hash.key?('dotNumber') ? hash['dotNumber'] : nil
+      carrier_name = hash.key?('carrierName') ? hash['carrierName'] : SKIP
+      mc_number = hash.key?('mcNumber') ? hash['mcNumber'] : SKIP
+      scac = hash.key?('scac') ? hash['scac'] : 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.
+      CarrierInput1.new(dot_number: dot_number,
+                        carrier_name: carrier_name,
+                        mc_number: mc_number,
+                        scac: scac,
+                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CarrierInput1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.dot_number,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['dotNumber'],
+                            ->(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} carrier_name: #{@carrier_name}, mc_number: #{@mc_number}, dot_number:"\
+      " #{@dot_number}, scac: #{@scac}, 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} carrier_name: #{@carrier_name.inspect}, mc_number: #{@mc_number.inspect},"\
+      " dot_number: #{@dot_number.inspect}, scac: #{@scac.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/charge_code.rb

@@ -0,0 +1,126 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Structured charge code identifying the type of charge and the standard or
+  # system it originates from. Allows carriers, factors, and industry standards
+  # to coexist on the same invoice.
+  class ChargeCode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates the system or standard from which a charge code originates.
+    # Helps TQL normalize and map charge codes across different partners.
+    # @return [ChargeCodeOrigin]
+    attr_accessor :origin
+
+    # The charge code value. Interpretation depends on `origin`. For SAC origin,
+    # common values include: 400 (Line-haul), 420 (Fuel Surcharge), 430
+    # (Detention — Loading), 431 (Detention — Unloading), 440 (Stop-off), 450
+    # (Accessorial — General), 455 (Hazmat), 460 (Lumper Fee), 465 (TONU), 470
+    # (Layover), 475/476 (Driver Assist), 480 (Re-delivery), 485
+    # (Reconsignment), 490 (Residential), 495 (Inside Delivery), 500 (Liftgate),
+    # 505 (Limited Access), 510 (Over-dimension), 520 (Overweight), 530
+    # (Reefer), 540 (Team Driver), 550 (Expedited), 560 (Border Crossing), 999
+    # (Other).
+    # @return [String]
+    attr_accessor :value
+
+    # Human-readable description of the charge code.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['origin'] = 'origin'
+      @_hash['value'] = 'value'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        origin
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(value:, description:, origin: ChargeCodeOrigin::SAC,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @origin = origin unless origin == SKIP
+      @value = value
+      @description = description
+      @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.
+      value = hash.key?('value') ? hash['value'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      origin = hash['origin'] ||= ChargeCodeOrigin::SAC
+
+      # 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.
+      ChargeCode.new(value: value,
+                     description: description,
+                     origin: origin,
+                     additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ChargeCode | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.value,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.description,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['value'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['description'],
+                                ->(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} origin: #{@origin}, value: #{@value}, description: #{@description},"\
+      " 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} origin: #{@origin.inspect}, value: #{@value.inspect}, description:"\
+      " #{@description.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/charge_code_origin.rb

@@ -0,0 +1,49 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Indicates the system or standard from which a charge code originates. Helps
+  # TQL normalize and map charge codes across different partners.
+  class ChargeCodeOrigin
+    CHARGE_CODE_ORIGIN = [
+      # TODO: Write general description for CARRIER
+      CARRIER = 'Carrier'.freeze,
+
+      # TODO: Write general description for FACTOR
+      FACTOR = 'Factor'.freeze,
+
+      # TODO: Write general description for SAC
+      SAC = 'SAC'.freeze,
+
+      # TODO: Write general description for NMFC
+      NMFC = 'NMFC'.freeze,
+
+      # TODO: Write general description for SMC3
+      SMC3 = 'SMC3'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHARGE_CODE_ORIGIN.include?(value)
+    end
+
+    def self.from_value(value, default_value = CARRIER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'carrier' then CARRIER
+      when 'factor' then FACTOR
+      when 'sac' then SAC
+      when 'nmfc' then NMFC
+      when 'smc3' then SMC3
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/charge_input.rb

@@ -0,0 +1,146 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # A single carrier charge line item. The `chargeCode` object identifies the
+  # charge type and its originating standard or system.
+  class ChargeInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Structured charge code identifying the type of charge and the standard or
+    # system it originates from. Allows carriers, factors, and industry
+    # standards to coexist on the same invoice.
+    # @return [ChargeCode]
+    attr_accessor :charge_code
+
+    # Monetary amount of the charge.
+    # @return [Float]
+    attr_accessor :amount
+
+    # Optional reference to an `InvoiceItemInput.itemId`, linking this charge to
+    # a specific freight item.
+    # @return [String]
+    attr_accessor :item_id
+
+    # [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency
+    # code. Defaults to USD.
+    # @return [String]
+    attr_accessor :currency
+
+    # The factoring company's own identifier for this charge line item. Echoed
+    # back in responses for reconciliation.
+    # @return [String]
+    attr_accessor :external_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['charge_code'] = 'chargeCode'
+      @_hash['amount'] = 'amount'
+      @_hash['item_id'] = 'itemId'
+      @_hash['currency'] = 'currency'
+      @_hash['external_id'] = 'externalId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        item_id
+        currency
+        external_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        item_id
+        external_id
+      ]
+    end
+
+    def initialize(charge_code:, amount:, item_id: SKIP, currency: 'USD',
+                   external_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @charge_code = charge_code
+      @amount = amount
+      @item_id = item_id unless item_id == SKIP
+      @currency = currency unless currency == SKIP
+      @external_id = external_id unless external_id == 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.
+      charge_code = ChargeCode.from_hash(hash['chargeCode']) if hash['chargeCode']
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      item_id = hash.key?('itemId') ? hash['itemId'] : SKIP
+      currency = hash['currency'] ||= 'USD'
+      external_id = hash.key?('externalId') ? hash['externalId'] : 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.
+      ChargeInput.new(charge_code: charge_code,
+                      amount: amount,
+                      item_id: item_id,
+                      currency: currency,
+                      external_id: external_id,
+                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ChargeInput | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.charge_code,
+                                ->(val) { ChargeCode.validate(val) },
+                                is_model_hash: true) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { val.instance_of? Float })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['chargeCode'],
+                              ->(val) { ChargeCode.validate(val) },
+                              is_model_hash: true) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { val.instance_of? Float })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} charge_code: #{@charge_code}, amount: #{@amount}, item_id: #{@item_id},"\
+      " currency: #{@currency}, external_id: #{@external_id}, 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} charge_code: #{@charge_code.inspect}, amount: #{@amount.inspect}, item_id:"\
+      " #{@item_id.inspect}, currency: #{@currency.inspect}, external_id: #{@external_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/document.rb

@@ -0,0 +1,86 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Document Model.
+  class Document < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # System-generated document identifier.
+    # @return [UUID | String]
+    attr_accessor :document_id
+
+    # Document type classification used for categorizing uploaded documents.
+    # @return [DocumentType]
+    attr_accessor :document_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['document_id'] = 'documentId'
+      @_hash['document_type'] = 'documentType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        document_id
+        document_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(document_id: SKIP, document_type: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @document_id = document_id unless document_id == SKIP
+      @document_type = document_type unless document_type == 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.
+      document_id = hash.key?('documentId') ? hash['documentId'] : SKIP
+      document_type = hash.key?('documentType') ? hash['documentType'] : 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.
+      Document.new(document_id: document_id,
+                   document_type: document_type,
+                   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} document_id: #{@document_id}, document_type: #{@document_type},"\
+      " 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} document_id: #{@document_id.inspect}, document_type:"\
+      " #{@document_type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end