apimatic-tql-sdk 0.0.1 → 0.0.2

data/lib/{tql_otr_factoring_data_exchange → freight_financials_webhook_ingestion_api}/models/invoice.rb

@@ -1,223 +1,204 @@
-# 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
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module FreightFinancialsWebhookIngestionApi
+  # Invoice Model.
+  class Invoice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Carrier]
+    attr_accessor :carrier
+
+    # TODO: Write general description for this method
+    # @return [Array[InvoiceDocument]]
+    attr_accessor :documents
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :factoring_company_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :factoring_company_name
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_claim
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :invoice_number
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :last_updated_at
+
+    # TODO: Write general description for this method
+    # @return [LoadSlim]
+    attr_accessor :load
+
+    # TODO: Write general description for this method
+    # @return [Payment]
+    attr_accessor :payment
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :submitted_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :uri
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier'] = 'carrier'
+      @_hash['documents'] = 'documents'
+      @_hash['factoring_company_id'] = 'factoringCompanyId'
+      @_hash['factoring_company_name'] = 'factoringCompanyName'
+      @_hash['has_claim'] = 'hasClaim'
+      @_hash['invoice_number'] = 'invoiceNumber'
+      @_hash['last_updated_at'] = 'lastUpdatedAt'
+      @_hash['load'] = 'load'
+      @_hash['payment'] = 'payment'
+      @_hash['status'] = 'status'
+      @_hash['submitted_at'] = 'submittedAt'
+      @_hash['uri'] = 'uri'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier
+        documents
+        factoring_company_id
+        factoring_company_name
+        has_claim
+        invoice_number
+        last_updated_at
+        load
+        payment
+        status
+        submitted_at
+        uri
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        factoring_company_id
+        uri
+      ]
+    end
+
+    def initialize(carrier: SKIP, documents: SKIP, factoring_company_id: SKIP,
+                   factoring_company_name: SKIP, has_claim: SKIP,
+                   invoice_number: SKIP, last_updated_at: SKIP, load: SKIP,
+                   payment: SKIP, status: SKIP, submitted_at: SKIP, uri: SKIP)
+      @carrier = carrier unless carrier == SKIP
+      @documents = documents unless documents == SKIP
+      @factoring_company_id = factoring_company_id unless factoring_company_id == SKIP
+      @factoring_company_name = factoring_company_name unless factoring_company_name == SKIP
+      @has_claim = has_claim unless has_claim == SKIP
+      @invoice_number = invoice_number unless invoice_number == SKIP
+      @last_updated_at = last_updated_at unless last_updated_at == SKIP
+      @load = load unless load == SKIP
+      @payment = payment unless payment == SKIP
+      @status = status unless status == SKIP
+      @submitted_at = submitted_at unless submitted_at == SKIP
+      @uri = uri unless uri == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      carrier = Carrier.from_hash(hash['carrier']) if hash['carrier']
+      # Parameter is an array, so we need to iterate through it
+      documents = nil
+      unless hash['documents'].nil?
+        documents = []
+        hash['documents'].each do |structure|
+          documents << (InvoiceDocument.from_hash(structure) if structure)
+        end
+      end
+
+      documents = SKIP unless hash.key?('documents')
+      factoring_company_id =
+        hash.key?('factoringCompanyId') ? hash['factoringCompanyId'] : SKIP
+      factoring_company_name =
+        hash.key?('factoringCompanyName') ? hash['factoringCompanyName'] : SKIP
+      has_claim = hash.key?('hasClaim') ? hash['hasClaim'] : SKIP
+      invoice_number = hash.key?('invoiceNumber') ? hash['invoiceNumber'] : SKIP
+      last_updated_at = if hash.key?('lastUpdatedAt')
+                          (DateTimeHelper.from_rfc3339(hash['lastUpdatedAt']) if hash['lastUpdatedAt'])
+                        else
+                          SKIP
+                        end
+      load = LoadSlim.from_hash(hash['load']) if hash['load']
+      payment = Payment.from_hash(hash['payment']) if hash['payment']
+      status = hash.key?('status') ? hash['status'] : SKIP
+      submitted_at = if hash.key?('submittedAt')
+                       (DateTimeHelper.from_rfc3339(hash['submittedAt']) if hash['submittedAt'])
+                     else
+                       SKIP
+                     end
+      uri = hash.key?('uri') ? hash['uri'] : SKIP
+
+      # Create object from extracted values.
+      Invoice.new(carrier: carrier,
+                  documents: documents,
+                  factoring_company_id: factoring_company_id,
+                  factoring_company_name: factoring_company_name,
+                  has_claim: has_claim,
+                  invoice_number: invoice_number,
+                  last_updated_at: last_updated_at,
+                  load: load,
+                  payment: payment,
+                  status: status,
+                  submitted_at: submitted_at,
+                  uri: uri)
+    end
+
+    def to_custom_last_updated_at
+      DateTimeHelper.to_rfc3339(last_updated_at)
+    end
+
+    def to_custom_submitted_at
+      DateTimeHelper.to_rfc3339(submitted_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier: #{@carrier}, documents: #{@documents}, factoring_company_id:"\
+      " #{@factoring_company_id}, factoring_company_name: #{@factoring_company_name}, has_claim:"\
+      " #{@has_claim}, invoice_number: #{@invoice_number}, last_updated_at: #{@last_updated_at},"\
+      " load: #{@load}, payment: #{@payment}, status: #{@status}, submitted_at: #{@submitted_at},"\
+      " uri: #{@uri}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier: #{@carrier.inspect}, documents: #{@documents.inspect},"\
+      " factoring_company_id: #{@factoring_company_id.inspect}, factoring_company_name:"\
+      " #{@factoring_company_name.inspect}, has_claim: #{@has_claim.inspect}, invoice_number:"\
+      " #{@invoice_number.inspect}, last_updated_at: #{@last_updated_at.inspect}, load:"\
+      " #{@load.inspect}, payment: #{@payment.inspect}, status: #{@status.inspect}, submitted_at:"\
+      " #{@submitted_at.inspect}, uri: #{@uri.inspect}>"
+    end
+  end
+end

data/lib/{tql_otr_factoring_data_exchange/models/document.rb → freight_financials_webhook_ingestion_api/models/invoice_document.rb}

@@ -1,86 +1,72 @@
-# 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
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # InvoiceDocument Model.
+  class InvoiceDocument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :document_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    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)
+      @document_id = document_id unless document_id == SKIP
+      @document_type = document_type unless document_type == SKIP
+    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 object from extracted values.
+      InvoiceDocument.new(document_id: document_id,
+                          document_type: document_type)
+    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}>"
+    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}>"
+    end
+  end
+end