apimatic-tql-sdk 0.0.1 → 0.0.2

data/lib/{tql_otr_factoring_data_exchange/models/invoice_status_response.rb → freight_financials_webhook_ingestion_api/models/invoice_status_response_data.rb}

@@ -1,193 +1,185 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-require 'date'
-module TqlOtrFactoringDataExchange
-  # Current processing state of an invoice, including any outstanding exceptions
-  # that require resolution.
-  class InvoiceStatusResponse < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # The TQL load number this invoice was submitted against.
-    # @return [String]
-    attr_accessor :load_number
-
-    # The factoring company's invoice number.
-    # @return [String]
-    attr_accessor :invoice_number
-
-    # 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 received.
-    # @return [DateTime]
-    attr_accessor :received_at
-
-    # UTC timestamp when processing completed (null if still in progress).
-    # @return [DateTime]
-    attr_accessor :completed_at
-
-    # Sum of all charge amounts on the invoice.
-    # @return [Float]
-    attr_accessor :total_charge_amount
-
-    # [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency
-    # code.
-    # @return [String]
-    attr_accessor :currency
-
-    # Documents uploaded and linked to this invoice. Each entry indicates the
-    # document type. Empty array means no documents have been received yet.
-    # @return [Array[DocumentType]]
-    attr_accessor :documents
-
-    # Outstanding exceptions that need resolution. Empty array means no issues.
-    # @return [Array[InvoiceException]]
-    attr_accessor :exceptions
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['load_number'] = 'loadNumber'
-      @_hash['invoice_number'] = 'invoiceNumber'
-      @_hash['status'] = 'status'
-      @_hash['received_at'] = 'receivedAt'
-      @_hash['completed_at'] = 'completedAt'
-      @_hash['total_charge_amount'] = 'totalChargeAmount'
-      @_hash['currency'] = 'currency'
-      @_hash['documents'] = 'documents'
-      @_hash['exceptions'] = 'exceptions'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        load_number
-        invoice_number
-        status
-        received_at
-        completed_at
-        total_charge_amount
-        currency
-        documents
-        exceptions
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      %w[
-        completed_at
-      ]
-    end
-
-    def initialize(load_number: SKIP, invoice_number: SKIP, status: SKIP,
-                   received_at: SKIP, completed_at: SKIP,
-                   total_charge_amount: SKIP, currency: SKIP, documents: SKIP,
-                   exceptions: SKIP, additional_properties: nil)
-      # Add additional model properties to the instance
-      additional_properties = {} if additional_properties.nil?
-
-      @load_number = load_number unless load_number == SKIP
-      @invoice_number = invoice_number unless invoice_number == SKIP
-      @status = status unless status == SKIP
-      @received_at = received_at unless received_at == SKIP
-      @completed_at = completed_at unless completed_at == SKIP
-      @total_charge_amount = total_charge_amount unless total_charge_amount == SKIP
-      @currency = currency unless currency == SKIP
-      @documents = documents unless documents == SKIP
-      @exceptions = exceptions unless exceptions == 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'] : SKIP
-      invoice_number = hash.key?('invoiceNumber') ? hash['invoiceNumber'] : SKIP
-      status = hash.key?('status') ? hash['status'] : SKIP
-      received_at = if hash.key?('receivedAt')
-                      (DateTimeHelper.from_rfc3339(hash['receivedAt']) if hash['receivedAt'])
-                    else
-                      SKIP
-                    end
-      completed_at = if hash.key?('completedAt')
-                       (DateTimeHelper.from_rfc3339(hash['completedAt']) if hash['completedAt'])
-                     else
-                       SKIP
-                     end
-      total_charge_amount =
-        hash.key?('totalChargeAmount') ? hash['totalChargeAmount'] : SKIP
-      currency = hash.key?('currency') ? hash['currency'] : SKIP
-      documents = hash.key?('documents') ? hash['documents'] : SKIP
-      # Parameter is an array, so we need to iterate through it
-      exceptions = nil
-      unless hash['exceptions'].nil?
-        exceptions = []
-        hash['exceptions'].each do |structure|
-          exceptions << (InvoiceException.from_hash(structure) if structure)
-        end
-      end
-
-      exceptions = SKIP unless hash.key?('exceptions')
-
-      # 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.
-      InvoiceStatusResponse.new(load_number: load_number,
-                                invoice_number: invoice_number,
-                                status: status,
-                                received_at: received_at,
-                                completed_at: completed_at,
-                                total_charge_amount: total_charge_amount,
-                                currency: currency,
-                                documents: documents,
-                                exceptions: exceptions,
-                                additional_properties: additional_properties)
-    end
-
-    def to_custom_received_at
-      DateTimeHelper.to_rfc3339(received_at)
-    end
-
-    def to_custom_completed_at
-      DateTimeHelper.to_rfc3339(completed_at)
-    end
-
-    # Provides a human-readable string representation of the object.
-    def to_s
-      class_name = self.class.name.split('::').last
-      "<#{class_name} load_number: #{@load_number}, invoice_number: #{@invoice_number}, status:"\
-      " #{@status}, received_at: #{@received_at}, completed_at: #{@completed_at},"\
-      " total_charge_amount: #{@total_charge_amount}, currency: #{@currency}, documents:"\
-      " #{@documents}, exceptions: #{@exceptions}, 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} load_number: #{@load_number.inspect}, invoice_number:"\
-      " #{@invoice_number.inspect}, status: #{@status.inspect}, received_at:"\
-      " #{@received_at.inspect}, completed_at: #{@completed_at.inspect}, total_charge_amount:"\
-      " #{@total_charge_amount.inspect}, currency: #{@currency.inspect}, documents:"\
-      " #{@documents.inspect}, exceptions: #{@exceptions.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
+  # InvoiceStatusResponseData Model.
+  class InvoiceStatusResponseData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :completed_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :currency
+
+    # TODO: Write general description for this method
+    # @return [Array[Integer]]
+    attr_accessor :documents
+
+    # TODO: Write general description for this method
+    # @return [Array[InvoiceIssue]]
+    attr_accessor :issues
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :invoice_number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :load_number
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :received_at
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :total_charge_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['completed_at'] = 'completedAt'
+      @_hash['currency'] = 'currency'
+      @_hash['documents'] = 'documents'
+      @_hash['issues'] = 'issues'
+      @_hash['invoice_number'] = 'invoiceNumber'
+      @_hash['load_number'] = 'loadNumber'
+      @_hash['received_at'] = 'receivedAt'
+      @_hash['status'] = 'status'
+      @_hash['total_charge_amount'] = 'totalChargeAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        completed_at
+        currency
+        documents
+        issues
+        invoice_number
+        load_number
+        received_at
+        status
+        total_charge_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        completed_at
+      ]
+    end
+
+    def initialize(completed_at: SKIP, currency: SKIP, documents: SKIP,
+                   issues: SKIP, invoice_number: SKIP, load_number: SKIP,
+                   received_at: SKIP, status: SKIP, total_charge_amount: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @completed_at = completed_at unless completed_at == SKIP
+      @currency = currency unless currency == SKIP
+      @documents = documents unless documents == SKIP
+      @issues = issues unless issues == SKIP
+      @invoice_number = invoice_number unless invoice_number == SKIP
+      @load_number = load_number unless load_number == SKIP
+      @received_at = received_at unless received_at == SKIP
+      @status = status unless status == SKIP
+      @total_charge_amount = total_charge_amount unless total_charge_amount == 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.
+      completed_at = if hash.key?('completedAt')
+                       (DateTimeHelper.from_rfc3339(hash['completedAt']) if hash['completedAt'])
+                     else
+                       SKIP
+                     end
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      documents = hash.key?('documents') ? hash['documents'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      issues = nil
+      unless hash['issues'].nil?
+        issues = []
+        hash['issues'].each do |structure|
+          issues << (InvoiceIssue.from_hash(structure) if structure)
+        end
+      end
+
+      issues = SKIP unless hash.key?('issues')
+      invoice_number = hash.key?('invoiceNumber') ? hash['invoiceNumber'] : SKIP
+      load_number = hash.key?('loadNumber') ? hash['loadNumber'] : SKIP
+      received_at = if hash.key?('receivedAt')
+                      (DateTimeHelper.from_rfc3339(hash['receivedAt']) if hash['receivedAt'])
+                    else
+                      SKIP
+                    end
+      status = hash.key?('status') ? hash['status'] : SKIP
+      total_charge_amount =
+        hash.key?('totalChargeAmount') ? hash['totalChargeAmount'] : 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.
+      InvoiceStatusResponseData.new(completed_at: completed_at,
+                                    currency: currency,
+                                    documents: documents,
+                                    issues: issues,
+                                    invoice_number: invoice_number,
+                                    load_number: load_number,
+                                    received_at: received_at,
+                                    status: status,
+                                    total_charge_amount: total_charge_amount,
+                                    additional_properties: additional_properties)
+    end
+
+    def to_custom_completed_at
+      DateTimeHelper.to_rfc3339(completed_at)
+    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} completed_at: #{@completed_at}, currency: #{@currency}, documents:"\
+      " #{@documents}, issues: #{@issues}, invoice_number: #{@invoice_number}, load_number:"\
+      " #{@load_number}, received_at: #{@received_at}, status: #{@status}, total_charge_amount:"\
+      " #{@total_charge_amount}, 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} completed_at: #{@completed_at.inspect}, currency: #{@currency.inspect},"\
+      " documents: #{@documents.inspect}, issues: #{@issues.inspect}, invoice_number:"\
+      " #{@invoice_number.inspect}, load_number: #{@load_number.inspect}, received_at:"\
+      " #{@received_at.inspect}, status: #{@status.inspect}, total_charge_amount:"\
+      " #{@total_charge_amount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/freight_financials_webhook_ingestion_api/models/line_item.rb

@@ -0,0 +1,131 @@
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # LineItem Model.
+  class LineItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :freight_class
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :handling_unit
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :handling_unit_count
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :item_id
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :weight
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :weight_unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['freight_class'] = 'freightClass'
+      @_hash['handling_unit'] = 'handlingUnit'
+      @_hash['handling_unit_count'] = 'handlingUnitCount'
+      @_hash['item_id'] = 'itemId'
+      @_hash['weight'] = 'weight'
+      @_hash['weight_unit'] = 'weightUnit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        freight_class
+        handling_unit
+        handling_unit_count
+        item_id
+        weight
+        weight_unit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        freight_class
+        handling_unit
+        handling_unit_count
+        weight
+        weight_unit
+      ]
+    end
+
+    def initialize(description: SKIP, freight_class: SKIP, handling_unit: SKIP,
+                   handling_unit_count: SKIP, item_id: SKIP, weight: SKIP,
+                   weight_unit: SKIP)
+      @description = description unless description == SKIP
+      @freight_class = freight_class unless freight_class == SKIP
+      @handling_unit = handling_unit unless handling_unit == SKIP
+      @handling_unit_count = handling_unit_count unless handling_unit_count == SKIP
+      @item_id = item_id unless item_id == SKIP
+      @weight = weight unless weight == SKIP
+      @weight_unit = weight_unit unless weight_unit == 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.
+      description = hash.key?('description') ? hash['description'] : SKIP
+      freight_class = hash.key?('freightClass') ? hash['freightClass'] : SKIP
+      handling_unit = hash.key?('handlingUnit') ? hash['handlingUnit'] : SKIP
+      handling_unit_count =
+        hash.key?('handlingUnitCount') ? hash['handlingUnitCount'] : SKIP
+      item_id = hash.key?('itemId') ? hash['itemId'] : SKIP
+      weight = hash.key?('weight') ? hash['weight'] : SKIP
+      weight_unit = hash.key?('weightUnit') ? hash['weightUnit'] : SKIP
+
+      # Create object from extracted values.
+      LineItem.new(description: description,
+                   freight_class: freight_class,
+                   handling_unit: handling_unit,
+                   handling_unit_count: handling_unit_count,
+                   item_id: item_id,
+                   weight: weight,
+                   weight_unit: weight_unit)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description}, freight_class: #{@freight_class},"\
+      " handling_unit: #{@handling_unit}, handling_unit_count: #{@handling_unit_count}, item_id:"\
+      " #{@item_id}, weight: #{@weight}, weight_unit: #{@weight_unit}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description.inspect}, freight_class:"\
+      " #{@freight_class.inspect}, handling_unit: #{@handling_unit.inspect}, handling_unit_count:"\
+      " #{@handling_unit_count.inspect}, item_id: #{@item_id.inspect}, weight: #{@weight.inspect},"\
+      " weight_unit: #{@weight_unit.inspect}>"
+    end
+  end
+end

data/lib/freight_financials_webhook_ingestion_api/models/load_response.rb

@@ -0,0 +1,83 @@
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # LoadResponse Model.
+  class LoadResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [LoadResponseData]
+    attr_accessor :data
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :errors
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_success
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['errors'] = 'errors'
+      @_hash['is_success'] = 'isSuccess'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data
+        errors
+        is_success
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        data
+      ]
+    end
+
+    def initialize(data: SKIP, errors: SKIP, is_success: SKIP)
+      @data = data unless data == SKIP
+      @errors = errors unless errors == SKIP
+      @is_success = is_success unless is_success == 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.
+      data = LoadResponseData.from_hash(hash['data']) if hash['data']
+      errors = hash.key?('errors') ? hash['errors'] : SKIP
+      is_success = hash.key?('isSuccess') ? hash['isSuccess'] : SKIP
+
+      # Create object from extracted values.
+      LoadResponse.new(data: data,
+                       errors: errors,
+                       is_success: is_success)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data}, errors: #{@errors}, is_success: #{@is_success}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data.inspect}, errors: #{@errors.inspect}, is_success:"\
+      " #{@is_success.inspect}>"
+    end
+  end
+end