apimatic-tql-sdk 0.0.1 → 0.0.2

data/lib/freight_financials_webhook_ingestion_api/models/navix_rate_stop.rb

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

data/lib/freight_financials_webhook_ingestion_api/models/navix_rate_vendor.rb

@@ -0,0 +1,88 @@
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # NavixRateVendor Model.
+  class NavixRateVendor < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :external_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :scac
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['external_id'] = 'externalId'
+      @_hash['scac'] = 'SCAC'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_id
+        scac
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        external_id
+        scac
+      ]
+    end
+
+    def initialize(external_id: SKIP, scac: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @external_id = external_id unless external_id == SKIP
+      @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.
+      external_id = hash.key?('externalId') ? hash['externalId'] : 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.
+      NavixRateVendor.new(external_id: external_id,
+                          scac: scac,
+                          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} external_id: #{@external_id}, 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} external_id: #{@external_id.inspect}, scac: #{@scac.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/freight_financials_webhook_ingestion_api/models/navix_webhook_event_type.rb

@@ -0,0 +1,56 @@
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # NavixWebhookEventType.
+  class NavixWebhookEventType
+    NAVIX_WEBHOOK_EVENT_TYPE = [
+      # TODO: Write general description for INVOICE_CREATED
+      INVOICE_CREATED = 'INVOICE_CREATED'.freeze,
+
+      # TODO: Write general description for INVOICE_APPROVED
+      INVOICE_APPROVED = 'INVOICE_APPROVED'.freeze,
+
+      # TODO: Write general description for DISPUTE_CREATED
+      DISPUTE_CREATED = 'DISPUTE_CREATED'.freeze,
+
+      # TODO: Write general description for DISPUTE_UPDATED
+      DISPUTE_UPDATED = 'DISPUTE_UPDATED'.freeze,
+
+      # TODO: Write general description for DISPUTE_COMMUNICATION_CREATED
+      DISPUTE_COMMUNICATION_CREATED = 'DISPUTE_COMMUNICATION_CREATED'.freeze,
+
+      # TODO: Write general description for ORDER_APPROVED
+      ORDER_APPROVED = 'ORDER_APPROVED'.freeze,
+
+      # TODO: Write general description for DOCUMENT_APPROVED
+      DOCUMENT_APPROVED = 'DOCUMENT_APPROVED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      NAVIX_WEBHOOK_EVENT_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = INVOICE_CREATED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'invoice_created' then INVOICE_CREATED
+      when 'invoice_approved' then INVOICE_APPROVED
+      when 'dispute_created' then DISPUTE_CREATED
+      when 'dispute_updated' then DISPUTE_UPDATED
+      when 'dispute_communication_created' then DISPUTE_COMMUNICATION_CREATED
+      when 'order_approved' then ORDER_APPROVED
+      when 'document_approved' then DOCUMENT_APPROVED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/freight_financials_webhook_ingestion_api/models/navix_webhook_request.rb

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

data/lib/freight_financials_webhook_ingestion_api/models/paged_response_of_invoice.rb

@@ -0,0 +1,111 @@
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # PagedResponseOfInvoice Model.
+  class PagedResponseOfInvoice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :page_number
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # TODO: Write general description for this method
+    # @return [Array[Invoice]]
+    attr_accessor :results
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page_number'] = 'pageNumber'
+      @_hash['page_size'] = 'pageSize'
+      @_hash['total_count'] = 'totalCount'
+      @_hash['total_pages'] = 'totalPages'
+      @_hash['results'] = 'results'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page_number
+        page_size
+        total_count
+        total_pages
+        results
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page_number: SKIP, page_size: SKIP, total_count: SKIP,
+                   total_pages: SKIP, results: SKIP)
+      @page_number = page_number unless page_number == SKIP
+      @page_size = page_size unless page_size == SKIP
+      @total_count = total_count unless total_count == SKIP
+      @total_pages = total_pages unless total_pages == SKIP
+      @results = results unless results == 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.
+      page_number = hash.key?('pageNumber') ? hash['pageNumber'] : SKIP
+      page_size = hash.key?('pageSize') ? hash['pageSize'] : SKIP
+      total_count = hash.key?('totalCount') ? hash['totalCount'] : SKIP
+      total_pages = hash.key?('totalPages') ? hash['totalPages'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      results = nil
+      unless hash['results'].nil?
+        results = []
+        hash['results'].each do |structure|
+          results << (Invoice.from_hash(structure) if structure)
+        end
+      end
+
+      results = SKIP unless hash.key?('results')
+
+      # Create object from extracted values.
+      PagedResponseOfInvoice.new(page_number: page_number,
+                                 page_size: page_size,
+                                 total_count: total_count,
+                                 total_pages: total_pages,
+                                 results: results)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page_number: #{@page_number}, page_size: #{@page_size}, total_count:"\
+      " #{@total_count}, total_pages: #{@total_pages}, results: #{@results}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page_number: #{@page_number.inspect}, page_size: #{@page_size.inspect},"\
+      " total_count: #{@total_count.inspect}, total_pages: #{@total_pages.inspect}, results:"\
+      " #{@results.inspect}>"
+    end
+  end
+end

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

@@ -1,108 +1,94 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-module TqlOtrFactoringDataExchange
-  # Payment and billing details for this invoice.
-  class Payment < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # Total invoiced amount.
-    # @return [Float]
-    attr_accessor :invoice_amount
-
-    # Amount paid against this invoice so far.
-    # @return [Float]
-    attr_accessor :paid_amount
-
-    # [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency
-    # code.
-    # @return [String]
-    attr_accessor :currency
-
-    # Payment due date.
-    # @return [Date]
-    attr_accessor :due_date
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['invoice_amount'] = 'invoiceAmount'
-      @_hash['paid_amount'] = 'paidAmount'
-      @_hash['currency'] = 'currency'
-      @_hash['due_date'] = 'dueDate'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        invoice_amount
-        paid_amount
-        currency
-        due_date
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      %w[
-        due_date
-      ]
-    end
-
-    def initialize(invoice_amount: SKIP, paid_amount: SKIP, currency: SKIP,
-                   due_date: SKIP, additional_properties: nil)
-      # Add additional model properties to the instance
-      additional_properties = {} if additional_properties.nil?
-
-      @invoice_amount = invoice_amount unless invoice_amount == SKIP
-      @paid_amount = paid_amount unless paid_amount == SKIP
-      @currency = currency unless currency == SKIP
-      @due_date = due_date unless due_date == 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_amount = hash.key?('invoiceAmount') ? hash['invoiceAmount'] : SKIP
-      paid_amount = hash.key?('paidAmount') ? hash['paidAmount'] : SKIP
-      currency = hash.key?('currency') ? hash['currency'] : SKIP
-      due_date = hash.key?('dueDate') ? hash['dueDate'] : 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.
-      Payment.new(invoice_amount: invoice_amount,
-                  paid_amount: paid_amount,
-                  currency: currency,
-                  due_date: due_date,
-                  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_amount: #{@invoice_amount}, paid_amount: #{@paid_amount}, currency:"\
-      " #{@currency}, due_date: #{@due_date}, 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_amount: #{@invoice_amount.inspect}, paid_amount:"\
-      " #{@paid_amount.inspect}, currency: #{@currency.inspect}, due_date: #{@due_date.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
+  # Payment Model.
+  class Payment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :currency
+
+    # TODO: Write general description for this method
+    # @return [Date]
+    attr_accessor :due_date
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :invoice_amount
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :paid_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['due_date'] = 'dueDate'
+      @_hash['invoice_amount'] = 'invoiceAmount'
+      @_hash['paid_amount'] = 'paidAmount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+        due_date
+        invoice_amount
+        paid_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        due_date
+      ]
+    end
+
+    def initialize(currency: SKIP, due_date: SKIP, invoice_amount: SKIP,
+                   paid_amount: SKIP)
+      @currency = currency unless currency == SKIP
+      @due_date = due_date unless due_date == SKIP
+      @invoice_amount = invoice_amount unless invoice_amount == SKIP
+      @paid_amount = paid_amount unless paid_amount == 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.
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      due_date = hash.key?('dueDate') ? hash['dueDate'] : SKIP
+      invoice_amount = hash.key?('invoiceAmount') ? hash['invoiceAmount'] : SKIP
+      paid_amount = hash.key?('paidAmount') ? hash['paidAmount'] : SKIP
+
+      # Create object from extracted values.
+      Payment.new(currency: currency,
+                  due_date: due_date,
+                  invoice_amount: invoice_amount,
+                  paid_amount: paid_amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency}, due_date: #{@due_date}, invoice_amount:"\
+      " #{@invoice_amount}, paid_amount: #{@paid_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency.inspect}, due_date: #{@due_date.inspect},"\
+      " invoice_amount: #{@invoice_amount.inspect}, paid_amount: #{@paid_amount.inspect}>"
+    end
+  end
+end