apimatic-tql-sdk 0.0.1

data/lib/tql_otr_factoring_data_exchange/models/document_type.rb

@@ -0,0 +1,288 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Document type classification used for categorizing uploaded documents.
+  class DocumentType
+    DOCUMENT_TYPE = [
+      # TODO: Write general description for INVOICE
+      INVOICE = 'Invoice'.freeze,
+
+      # TODO: Write general description for DELIVERYRECEIPT
+      DELIVERYRECEIPT = 'DeliveryReceipt'.freeze,
+
+      # TODO: Write general description for PROOFOFDELIVERY
+      PROOFOFDELIVERY = 'ProofOfDelivery'.freeze,
+
+      # TODO: Write general description for BILLOFLADING
+      BILLOFLADING = 'BillOfLading'.freeze,
+
+      # TODO: Write general description for NOTICEOFASSIGNMENT
+      NOTICEOFASSIGNMENT = 'NoticeOfAssignment'.freeze,
+
+      # TODO: Write general description for RATECONFIRMATION
+      RATECONFIRMATION = 'RateConfirmation'.freeze,
+
+      # TODO: Write general description for WEIGHTANDINSPECTIONCERT
+      WEIGHTANDINSPECTIONCERT = 'WeightAndInspectionCert'.freeze,
+
+      # TODO: Write general description for WEIGHTANDINSPECTIONCERTIFICATE
+      WEIGHTANDINSPECTIONCERTIFICATE = 'WeightAndInspectionCertificate'.freeze,
+
+      # TODO: Write general description for LETTEROFAUTHORITY
+      LETTEROFAUTHORITY = 'LetterOfAuthority'.freeze,
+
+      # TODO: Write general description for LUMPERRECEIPT
+      LUMPERRECEIPT = 'LumperReceipt'.freeze,
+
+      # TODO: Write general description for PACKINGLIST
+      PACKINGLIST = 'PackingList'.freeze,
+
+      # TODO: Write general description for GENERATEDINVOICE
+      GENERATEDINVOICE = 'GeneratedInvoice'.freeze,
+
+      # TODO: Write general description for EMAIL
+      EMAIL = 'Email'.freeze,
+
+      # TODO: Write general description for INBOUNDEMAIL
+      INBOUNDEMAIL = 'InboundEmail'.freeze,
+
+      # TODO: Write general description for COMMERCIALINVOICE
+      COMMERCIALINVOICE = 'CommercialInvoice'.freeze,
+
+      # TODO: Write general description for CERTIFICATEOFORIGIN
+      CERTIFICATEOFORIGIN = 'CertificateOfOrigin'.freeze,
+
+      # TODO: Write general description for CUSTOMERRATECONFIRMATION
+      CUSTOMERRATECONFIRMATION = 'CustomerRateConfirmation'.freeze,
+
+      # TODO: Write general description for ELECTRONICINTERCHANGERECEIPT
+      ELECTRONICINTERCHANGERECEIPT = 'ElectronicInterchangeReceipt'.freeze,
+
+      # TODO: Write general description for GATEPASS
+      GATEPASS = 'GatePass'.freeze,
+
+      # TODO: Write general description for GATEOUTINTICKET
+      GATEOUTINTICKET = 'GateOutInTicket'.freeze,
+
+      # TODO: Write general description for INSURANCECERTIFICATE
+      INSURANCECERTIFICATE = 'InsuranceCertificate'.freeze,
+
+      # TODO: Write general description for OTHERRECEIPT
+      OTHERRECEIPT = 'OtherReceipt'.freeze,
+
+      # TODO: Write general description for W9
+      W9 = 'W9'.freeze,
+
+      # TODO: Write general description for DELIVERYORDER
+      DELIVERYORDER = 'DeliveryOrder'.freeze,
+
+      # TODO: Write general description for WEIGHTSCALETICKET
+      WEIGHTSCALETICKET = 'WeightScaleTicket'.freeze,
+
+      # TODO: Write general description for TRAILERINTERCHANGERECEIPT
+      TRAILERINTERCHANGERECEIPT = 'TrailerInterchangeReceipt'.freeze,
+
+      # TODO: Write general description for PURCHASEORDER
+      PURCHASEORDER = 'PurchaseOrder'.freeze,
+
+      # TODO: Write general description for ESCORTTICKET
+      ESCORTTICKET = 'EscortTicket'.freeze,
+
+      # TODO: Write general description for PERMITRECEIPT
+      PERMITRECEIPT = 'PermitReceipt'.freeze,
+
+      # TODO: Write general description for SERVICEORDER
+      SERVICEORDER = 'ServiceOrder'.freeze,
+
+      # TODO: Write general description for CERTIFICATEOFDESTRUCTION
+      CERTIFICATEOFDESTRUCTION = 'CertificateOfDestruction'.freeze,
+
+      # TODO: Write general description for DONATIONRECEIPT
+      DONATIONRECEIPT = 'DonationReceipt'.freeze,
+
+      # TODO: Write general description for SMARTANDFINALSTAMP
+      SMARTANDFINALSTAMP = 'SmartAndFinalStamp'.freeze,
+
+      # TODO: Write general description for INBOUNDTRIPREPORT
+      INBOUNDTRIPREPORT = 'InboundTripReport'.freeze,
+
+      # TODO: Write general description for WEIGHMASTERCERTIFICATE
+      WEIGHMASTERCERTIFICATE = 'WeighmasterCertificate'.freeze,
+
+      # TODO: Write general description for CARGOACTIVITYSHEET
+      CARGOACTIVITYSHEET = 'CargoActivitySheet'.freeze,
+
+      # TODO: Write general description for WEBERBOL
+      WEBERBOL = 'WeberBOL'.freeze,
+
+      # TODO: Write general description for TIMECARD
+      TIMECARD = 'TimeCard'.freeze,
+
+      # TODO: Write general description for TRANSFERSHEET
+      TRANSFERSHEET = 'TransferSheet'.freeze,
+
+      # TODO: Write general description for TRIPMANIFEST
+      TRIPMANIFEST = 'TripManifest'.freeze,
+
+      # TODO: Write general description for TRAILERCONTROLRECORD
+      TRAILERCONTROLRECORD = 'TrailerControlRecord'.freeze,
+
+      # TODO: Write general description for TARGETTRIPSHEET
+      TARGETTRIPSHEET = 'TargetTripSheet'.freeze,
+
+      # TODO: Write general description for EXITPASS
+      EXITPASS = 'ExitPass'.freeze,
+
+      # TODO: Write general description for PORTOFARTHURBOL
+      PORTOFARTHURBOL = 'PortOfArthurBOL'.freeze,
+
+      # TODO: Write general description for COLDCHAINCUSTODYFORM
+      COLDCHAINCUSTODYFORM = 'ColdChainCustodyForm'.freeze,
+
+      # TODO: Write general description for IGFFREIGHTDISPATCH
+      IGFFREIGHTDISPATCH = 'IGFFreightDispatch'.freeze,
+
+      # TODO: Write general description for EQUIPMENTSUBMISSIONFORM
+      EQUIPMENTSUBMISSIONFORM = 'EquipmentSubmissionForm'.freeze,
+
+      # TODO: Write general description for RELEASE
+      RELEASE = 'Release'.freeze,
+
+      # TODO: Write general description for ACIMANIFEST
+      ACIMANIFEST = 'ACIManifest'.freeze,
+
+      # TODO: Write general description for TRAILERPICTURE
+      TRAILERPICTURE = 'TrailerPicture'.freeze,
+
+      # TODO: Write general description for MATERIALSAFETYDATASHEET
+      MATERIALSAFETYDATASHEET = 'MaterialSafetyDataSheet'.freeze,
+
+      # TODO: Write general description for SHIPTICKET
+      SHIPTICKET = 'ShipTicket'.freeze,
+
+      # TODO: Write general description for DELIVERYTICKET
+      DELIVERYTICKET = 'DeliveryTicket'.freeze,
+
+      # TODO: Write general description for INVOICECORRECTED
+      INVOICECORRECTED = 'InvoiceCorrected'.freeze,
+
+      # TODO: Write general description for EIRTICKET
+      EIRTICKET = 'EIRTicket'.freeze,
+
+      # TODO: Write general description for PALLETRECEIPT
+      PALLETRECEIPT = 'PalletReceipt'.freeze,
+
+      # TODO: Write general description for HISTORICALAUDITDOCUMENTS
+      HISTORICALAUDITDOCUMENTS = 'HistoricalAuditDocuments'.freeze,
+
+      # TODO: Write general description for DETENTIONRECEIPT
+      DETENTIONRECEIPT = 'DetentionReceipt'.freeze,
+
+      # TODO: Write general description for MANIFEST
+      MANIFEST = 'Manifest'.freeze,
+
+      # TODO: Write general description for CUSTOMERRATEAPPROVAL
+      CUSTOMERRATEAPPROVAL = 'CustomerRateApproval'.freeze,
+
+      # TODO: Write general description for LOADCOVERSHEET
+      LOADCOVERSHEET = 'LoadCoverSheet'.freeze,
+
+      # TODO: Write general description for SAFETYCHECKLIST
+      SAFETYCHECKLIST = 'SafetyChecklist'.freeze,
+
+      # TODO: Write general description for WALMARTDELIVERYCONFIRMATIONREPORT
+      WALMARTDELIVERYCONFIRMATIONREPORT = 'WalmartDeliveryConfirmationReport'.freeze,
+
+      # TODO: Write general description for STATEMENTINVOICE
+      STATEMENTINVOICE = 'StatementInvoice'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'Unknown'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DOCUMENT_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 'deliveryreceipt' then DELIVERYRECEIPT
+      when 'proofofdelivery' then PROOFOFDELIVERY
+      when 'billoflading' then BILLOFLADING
+      when 'noticeofassignment' then NOTICEOFASSIGNMENT
+      when 'rateconfirmation' then RATECONFIRMATION
+      when 'weightandinspectioncert' then WEIGHTANDINSPECTIONCERT
+      when 'weightandinspectioncertificate' then WEIGHTANDINSPECTIONCERTIFICATE
+      when 'letterofauthority' then LETTEROFAUTHORITY
+      when 'lumperreceipt' then LUMPERRECEIPT
+      when 'packinglist' then PACKINGLIST
+      when 'generatedinvoice' then GENERATEDINVOICE
+      when 'email' then EMAIL
+      when 'inboundemail' then INBOUNDEMAIL
+      when 'commercialinvoice' then COMMERCIALINVOICE
+      when 'certificateoforigin' then CERTIFICATEOFORIGIN
+      when 'customerrateconfirmation' then CUSTOMERRATECONFIRMATION
+      when 'electronicinterchangereceipt' then ELECTRONICINTERCHANGERECEIPT
+      when 'gatepass' then GATEPASS
+      when 'gateoutinticket' then GATEOUTINTICKET
+      when 'insurancecertificate' then INSURANCECERTIFICATE
+      when 'otherreceipt' then OTHERRECEIPT
+      when 'w9' then W9
+      when 'deliveryorder' then DELIVERYORDER
+      when 'weightscaleticket' then WEIGHTSCALETICKET
+      when 'trailerinterchangereceipt' then TRAILERINTERCHANGERECEIPT
+      when 'purchaseorder' then PURCHASEORDER
+      when 'escortticket' then ESCORTTICKET
+      when 'permitreceipt' then PERMITRECEIPT
+      when 'serviceorder' then SERVICEORDER
+      when 'certificateofdestruction' then CERTIFICATEOFDESTRUCTION
+      when 'donationreceipt' then DONATIONRECEIPT
+      when 'smartandfinalstamp' then SMARTANDFINALSTAMP
+      when 'inboundtripreport' then INBOUNDTRIPREPORT
+      when 'weighmastercertificate' then WEIGHMASTERCERTIFICATE
+      when 'cargoactivitysheet' then CARGOACTIVITYSHEET
+      when 'weberbol' then WEBERBOL
+      when 'timecard' then TIMECARD
+      when 'transfersheet' then TRANSFERSHEET
+      when 'tripmanifest' then TRIPMANIFEST
+      when 'trailercontrolrecord' then TRAILERCONTROLRECORD
+      when 'targettripsheet' then TARGETTRIPSHEET
+      when 'exitpass' then EXITPASS
+      when 'portofarthurbol' then PORTOFARTHURBOL
+      when 'coldchaincustodyform' then COLDCHAINCUSTODYFORM
+      when 'igffreightdispatch' then IGFFREIGHTDISPATCH
+      when 'equipmentsubmissionform' then EQUIPMENTSUBMISSIONFORM
+      when 'release' then RELEASE
+      when 'acimanifest' then ACIMANIFEST
+      when 'trailerpicture' then TRAILERPICTURE
+      when 'materialsafetydatasheet' then MATERIALSAFETYDATASHEET
+      when 'shipticket' then SHIPTICKET
+      when 'deliveryticket' then DELIVERYTICKET
+      when 'invoicecorrected' then INVOICECORRECTED
+      when 'eirticket' then EIRTICKET
+      when 'palletreceipt' then PALLETRECEIPT
+      when 'historicalauditdocuments' then HISTORICALAUDITDOCUMENTS
+      when 'detentionreceipt' then DETENTIONRECEIPT
+      when 'manifest' then MANIFEST
+      when 'customerrateapproval' then CUSTOMERRATEAPPROVAL
+      when 'loadcoversheet' then LOADCOVERSHEET
+      when 'safetychecklist' then SAFETYCHECKLIST
+      when 'walmartdeliveryconfirmationreport' then WALMARTDELIVERYCONFIRMATIONREPORT
+      when 'statementinvoice' then STATEMENTINVOICE
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/document_upload_metadata.rb

@@ -0,0 +1,111 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Metadata for the document upload, provided as the `metadata` part of the
+  # `multipart/form-data` request. Specifies the invoice linkage, document
+  # classification, and optional tags.
+  class DocumentUploadMetadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The factoring company's invoice number this document is associated with.
+    # @return [String]
+    attr_accessor :invoice_number
+
+    # Document type classification used for categorizing uploaded documents.
+    # @return [DocumentType]
+    attr_accessor :document_type
+
+    # Original file name, if available.
+    # @return [String]
+    attr_accessor :file_name
+
+    # Arbitrary key-value metadata tags for this document. Keys and values are
+    # both strings. Use tags to annotate documents with operational data such as
+    # shortage counts, pallet quantities, seal numbers, etc.
+    # @return [Hash[String, String]]
+    attr_accessor :tags
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['invoice_number'] = 'invoiceNumber'
+      @_hash['document_type'] = 'documentType'
+      @_hash['file_name'] = 'fileName'
+      @_hash['tags'] = 'tags'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        file_name
+        tags
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        file_name
+        tags
+      ]
+    end
+
+    def initialize(invoice_number:, document_type:, file_name: SKIP, tags: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @invoice_number = invoice_number
+      @document_type = document_type
+      @file_name = file_name unless file_name == SKIP
+      @tags = tags unless tags == 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.
+      invoice_number = hash.key?('invoiceNumber') ? hash['invoiceNumber'] : nil
+      document_type = hash.key?('documentType') ? hash['documentType'] : nil
+      file_name = hash.key?('fileName') ? hash['fileName'] : SKIP
+      tags = hash.key?('tags') ? hash['tags'] : 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.
+      DocumentUploadMetadata.new(invoice_number: invoice_number,
+                                 document_type: document_type,
+                                 file_name: file_name,
+                                 tags: tags,
+                                 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} invoice_number: #{@invoice_number}, document_type: #{@document_type},"\
+      " file_name: #{@file_name}, tags: #{@tags}, 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} invoice_number: #{@invoice_number.inspect}, document_type:"\
+      " #{@document_type.inspect}, file_name: #{@file_name.inspect}, tags: #{@tags.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/document_upload_response.rb

@@ -0,0 +1,137 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module TqlOtrFactoringDataExchange
+  # Acknowledgement that the document was accepted for processing.
+  class DocumentUploadResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # System-generated unique identifier for this document.
+    # @return [UUID | String]
+    attr_accessor :document_id
+
+    # The invoice this document was linked to.
+    # @return [String]
+    attr_accessor :invoice_number
+
+    # Document type classification used for categorizing uploaded documents.
+    # @return [DocumentType]
+    attr_accessor :document_type
+
+    # Processing status of this document.
+    # @return [Status]
+    attr_accessor :status
+
+    # The tags that were submitted with this document (echoed back).
+    # @return [Hash[String, String]]
+    attr_accessor :tags
+
+    # UTC timestamp when the document was received.
+    # @return [DateTime]
+    attr_accessor :received_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['document_id'] = 'documentId'
+      @_hash['invoice_number'] = 'invoiceNumber'
+      @_hash['document_type'] = 'documentType'
+      @_hash['status'] = 'status'
+      @_hash['tags'] = 'tags'
+      @_hash['received_at'] = 'receivedAt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        document_id
+        invoice_number
+        document_type
+        status
+        tags
+        received_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        tags
+      ]
+    end
+
+    def initialize(document_id: SKIP, invoice_number: SKIP, document_type: SKIP,
+                   status: SKIP, tags: SKIP, received_at: 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
+      @invoice_number = invoice_number unless invoice_number == SKIP
+      @document_type = document_type unless document_type == SKIP
+      @status = status unless status == SKIP
+      @tags = tags unless tags == SKIP
+      @received_at = received_at unless received_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.
+      document_id = hash.key?('documentId') ? hash['documentId'] : SKIP
+      invoice_number = hash.key?('invoiceNumber') ? hash['invoiceNumber'] : SKIP
+      document_type = hash.key?('documentType') ? hash['documentType'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      tags = hash.key?('tags') ? hash['tags'] : SKIP
+      received_at = if hash.key?('receivedAt')
+                      (DateTimeHelper.from_rfc3339(hash['receivedAt']) if hash['receivedAt'])
+                    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.
+      DocumentUploadResponse.new(document_id: document_id,
+                                 invoice_number: invoice_number,
+                                 document_type: document_type,
+                                 status: status,
+                                 tags: tags,
+                                 received_at: received_at,
+                                 additional_properties: additional_properties)
+    end
+
+    def to_custom_received_at
+      DateTimeHelper.to_rfc3339(received_at)
+    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}, invoice_number: #{@invoice_number},"\
+      " document_type: #{@document_type}, status: #{@status}, tags: #{@tags}, received_at:"\
+      " #{@received_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} document_id: #{@document_id.inspect}, invoice_number:"\
+      " #{@invoice_number.inspect}, document_type: #{@document_type.inspect}, status:"\
+      " #{@status.inspect}, tags: #{@tags.inspect}, received_at: #{@received_at.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/exception_severity.rb

@@ -0,0 +1,40 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Severity level of a processing exception.
+  class ExceptionSeverity
+    EXCEPTION_SEVERITY = [
+      # TODO: Write general description for WARNING
+      WARNING = 'Warning'.freeze,
+
+      # TODO: Write general description for ERROR
+      ERROR = 'Error'.freeze,
+
+      # TODO: Write general description for CRITICAL
+      CRITICAL = 'Critical'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      EXCEPTION_SEVERITY.include?(value)
+    end
+
+    def self.from_value(value, default_value = WARNING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'warning' then WARNING
+      when 'error' then ERROR
+      when 'critical' then CRITICAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/factoring_company_input.rb

@@ -0,0 +1,117 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Identifies the factoring company that purchased (bought out) the carrier's
+  # loads.
+  class FactoringCompanyInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Legal or DBA name of the factoring company.
+    # @return [String]
+    attr_accessor :company_name
+
+    # Contact email address for the factoring company.
+    # @return [String]
+    attr_accessor :email
+
+    # Contact phone number for the factoring company.
+    # @return [String]
+    attr_accessor :phone
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['company_name'] = 'companyName'
+      @_hash['email'] = 'email'
+      @_hash['phone'] = 'phone'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(company_name:, email:, phone:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @company_name = company_name
+      @email = email
+      @phone = phone
+      @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.
+      company_name = hash.key?('companyName') ? hash['companyName'] : nil
+      email = hash.key?('email') ? hash['email'] : nil
+      phone = hash.key?('phone') ? hash['phone'] : nil
+
+      # 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.
+      FactoringCompanyInput.new(company_name: company_name,
+                                email: email,
+                                phone: phone,
+                                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FactoringCompanyInput | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.company_name,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.email,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.phone,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['companyName'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['email'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['phone'],
+                                ->(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} company_name: #{@company_name}, email: #{@email}, phone: #{@phone},"\
+      " 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} company_name: #{@company_name.inspect}, email: #{@email.inspect}, phone:"\
+      " #{@phone.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end