apimatic-tql-sdk 0.0.1 → 0.0.2

data/lib/freight_financials_webhook_ingestion_api/models/rating_charge_qualifier.rb

@@ -0,0 +1,68 @@
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # RatingChargeQualifier.
+  class RatingChargeQualifier
+    RATING_CHARGE_QUALIFIER = [
+      # TODO: Write general description for PERPOUND
+      PERPOUND = 'PerPound'.freeze,
+
+      # TODO: Write general description for PERHUNDREDWEIGHT
+      PERHUNDREDWEIGHT = 'PerHundredweight'.freeze,
+
+      # TODO: Write general description for PERTON
+      PERTON = 'PerTon'.freeze,
+
+      # TODO: Write general description for PERMILE
+      PERMILE = 'PerMile'.freeze,
+
+      # TODO: Write general description for PERKILOMETER
+      PERKILOMETER = 'PerKilometer'.freeze,
+
+      # TODO: Write general description for PERHOUR
+      PERHOUR = 'PerHour'.freeze,
+
+      # TODO: Write general description for PERCASE
+      PERCASE = 'PerCase'.freeze,
+
+      # TODO: Write general description for PERPALLET
+      PERPALLET = 'PerPallet'.freeze,
+
+      # TODO: Write general description for PERUNIT
+      PERUNIT = 'PerUnit'.freeze,
+
+      # TODO: Write general description for PERCENT
+      PERCENT = 'Percent'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RATING_CHARGE_QUALIFIER.include?(value)
+    end
+
+    def self.from_value(value, default_value = PERPOUND)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'perpound' then PERPOUND
+      when 'perhundredweight' then PERHUNDREDWEIGHT
+      when 'perton' then PERTON
+      when 'permile' then PERMILE
+      when 'perkilometer' then PERKILOMETER
+      when 'perhour' then PERHOUR
+      when 'percase' then PERCASE
+      when 'perpallet' then PERPALLET
+      when 'perunit' then PERUNIT
+      when 'percent' then PERCENT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/freight_financials_webhook_ingestion_api/models/rating_response_format.rb

@@ -0,0 +1,40 @@
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # RatingResponseFormat.
+  class RatingResponseFormat
+    RATING_RESPONSE_FORMAT = [
+      # TODO: Write general description for TEXT
+      TEXT = 'Text'.freeze,
+
+      # TODO: Write general description for JSON
+      JSON = 'Json'.freeze,
+
+      # TODO: Write general description for XML
+      XML = 'Xml'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RATING_RESPONSE_FORMAT.include?(value)
+    end
+
+    def self.from_value(value, default_value = TEXT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'text' then TEXT
+      when 'json' then JSON
+      when 'xml' then XML
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/freight_financials_webhook_ingestion_api/models/reference_number.rb

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

data/lib/{tql_otr_factoring_data_exchange/models/invoice_search_request.rb → freight_financials_webhook_ingestion_api/models/search_request.rb}

@@ -1,242 +1,223 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-require 'date'
-module TqlOtrFactoringDataExchange
-  # Search filters and pagination for querying invoices. All filter fields are
-  # optional — omit a filter to match all values for that field. **AND across
-  # fields, OR within arrays.** When multiple fields are supplied, all must
-  # match (AND). When an array-valued field (like `status`) contains multiple
-  # values, a match on *any* value satisfies that field (OR).
-  class InvoiceSearchRequest < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # 1-based page number.
-    # @return [Integer]
-    attr_accessor :page
-
-    # Number of results per page (max 100).
-    # @return [Integer]
-    attr_accessor :page_size
-
-    # Filter by one or more TQL load numbers (exact match, OR within the array).
-    # @return [Array[String]]
-    attr_accessor :load_numbers
-
-    # Filter by one or more factoring company invoice numbers (exact match, OR
-    # within the array).
-    # @return [Array[String]]
-    attr_accessor :invoice_numbers
-
-    # Filter by one or more invoice statuses (OR within the array).
-    # @return [Array[InvoiceStatus]]
-    attr_accessor :statuses
-
-    # Filter by one or more carrier names (partial match, OR within the array).
-    # @return [Array[String]]
-    attr_accessor :carrier_names
-
-    # Filter by one or more USDOT numbers (exact match, OR within the array).
-    # @return [Array[String]]
-    attr_accessor :carrier_dot_numbers
-
-    # Filter by one or more Motor Carrier (MC) numbers (exact match, OR within
-    # the array).
-    # @return [Array[String]]
-    attr_accessor :carrier_mc_numbers
-
-    # Only return invoices whose `lastUpdatedAt` is on or after this UTC
-    # timestamp.
-    # @return [DateTime]
-    attr_accessor :last_updated_after
-
-    # Only return invoices whose `lastUpdatedAt` is before this UTC timestamp.
-    # @return [DateTime]
-    attr_accessor :last_updated_before
-
-    # Only return invoices received on or after this UTC timestamp.
-    # @return [DateTime]
-    attr_accessor :received_after
-
-    # Only return invoices received before this UTC timestamp.
-    # @return [DateTime]
-    attr_accessor :received_before
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['page'] = 'page'
-      @_hash['page_size'] = 'pageSize'
-      @_hash['load_numbers'] = 'loadNumbers'
-      @_hash['invoice_numbers'] = 'invoiceNumbers'
-      @_hash['statuses'] = 'statuses'
-      @_hash['carrier_names'] = 'carrierNames'
-      @_hash['carrier_dot_numbers'] = 'carrierDotNumbers'
-      @_hash['carrier_mc_numbers'] = 'carrierMcNumbers'
-      @_hash['last_updated_after'] = 'lastUpdatedAfter'
-      @_hash['last_updated_before'] = 'lastUpdatedBefore'
-      @_hash['received_after'] = 'receivedAfter'
-      @_hash['received_before'] = 'receivedBefore'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        load_numbers
-        invoice_numbers
-        statuses
-        carrier_names
-        carrier_dot_numbers
-        carrier_mc_numbers
-        last_updated_after
-        last_updated_before
-        received_after
-        received_before
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      %w[
-        load_numbers
-        invoice_numbers
-        statuses
-        carrier_names
-        carrier_dot_numbers
-        carrier_mc_numbers
-        last_updated_after
-        last_updated_before
-        received_after
-        received_before
-      ]
-    end
-
-    def initialize(page:, page_size:, load_numbers: SKIP, invoice_numbers: SKIP,
-                   statuses: SKIP, carrier_names: SKIP,
-                   carrier_dot_numbers: SKIP, carrier_mc_numbers: SKIP,
-                   last_updated_after: SKIP, last_updated_before: SKIP,
-                   received_after: SKIP, received_before: SKIP,
-                   additional_properties: nil)
-      # Add additional model properties to the instance
-      additional_properties = {} if additional_properties.nil?
-
-      @page = page
-      @page_size = page_size
-      @load_numbers = load_numbers unless load_numbers == SKIP
-      @invoice_numbers = invoice_numbers unless invoice_numbers == SKIP
-      @statuses = statuses unless statuses == SKIP
-      @carrier_names = carrier_names unless carrier_names == SKIP
-      @carrier_dot_numbers = carrier_dot_numbers unless carrier_dot_numbers == SKIP
-      @carrier_mc_numbers = carrier_mc_numbers unless carrier_mc_numbers == SKIP
-      @last_updated_after = last_updated_after unless last_updated_after == SKIP
-      @last_updated_before = last_updated_before unless last_updated_before == SKIP
-      @received_after = received_after unless received_after == SKIP
-      @received_before = received_before unless received_before == 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.
-      page = hash.key?('page') ? hash['page'] : nil
-      page_size = hash.key?('pageSize') ? hash['pageSize'] : nil
-      load_numbers = hash.key?('loadNumbers') ? hash['loadNumbers'] : SKIP
-      invoice_numbers =
-        hash.key?('invoiceNumbers') ? hash['invoiceNumbers'] : SKIP
-      statuses = hash.key?('statuses') ? hash['statuses'] : SKIP
-      carrier_names = hash.key?('carrierNames') ? hash['carrierNames'] : SKIP
-      carrier_dot_numbers =
-        hash.key?('carrierDotNumbers') ? hash['carrierDotNumbers'] : SKIP
-      carrier_mc_numbers =
-        hash.key?('carrierMcNumbers') ? hash['carrierMcNumbers'] : SKIP
-      last_updated_after = if hash.key?('lastUpdatedAfter')
-                             (DateTimeHelper.from_rfc3339(hash['lastUpdatedAfter']) if hash['lastUpdatedAfter'])
-                           else
-                             SKIP
-                           end
-      last_updated_before = if hash.key?('lastUpdatedBefore')
-                              (DateTimeHelper.from_rfc3339(hash['lastUpdatedBefore']) if hash['lastUpdatedBefore'])
-                            else
-                              SKIP
-                            end
-      received_after = if hash.key?('receivedAfter')
-                         (DateTimeHelper.from_rfc3339(hash['receivedAfter']) if hash['receivedAfter'])
-                       else
-                         SKIP
-                       end
-      received_before = if hash.key?('receivedBefore')
-                          (DateTimeHelper.from_rfc3339(hash['receivedBefore']) if hash['receivedBefore'])
-                        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.
-      InvoiceSearchRequest.new(page: page,
-                               page_size: page_size,
-                               load_numbers: load_numbers,
-                               invoice_numbers: invoice_numbers,
-                               statuses: statuses,
-                               carrier_names: carrier_names,
-                               carrier_dot_numbers: carrier_dot_numbers,
-                               carrier_mc_numbers: carrier_mc_numbers,
-                               last_updated_after: last_updated_after,
-                               last_updated_before: last_updated_before,
-                               received_after: received_after,
-                               received_before: received_before,
-                               additional_properties: additional_properties)
-    end
-
-    def to_custom_last_updated_after
-      DateTimeHelper.to_rfc3339(last_updated_after)
-    end
-
-    def to_custom_last_updated_before
-      DateTimeHelper.to_rfc3339(last_updated_before)
-    end
-
-    def to_custom_received_after
-      DateTimeHelper.to_rfc3339(received_after)
-    end
-
-    def to_custom_received_before
-      DateTimeHelper.to_rfc3339(received_before)
-    end
-
-    # Provides a human-readable string representation of the object.
-    def to_s
-      class_name = self.class.name.split('::').last
-      "<#{class_name} page: #{@page}, page_size: #{@page_size}, load_numbers: #{@load_numbers},"\
-      " invoice_numbers: #{@invoice_numbers}, statuses: #{@statuses}, carrier_names:"\
-      " #{@carrier_names}, carrier_dot_numbers: #{@carrier_dot_numbers}, carrier_mc_numbers:"\
-      " #{@carrier_mc_numbers}, last_updated_after: #{@last_updated_after}, last_updated_before:"\
-      " #{@last_updated_before}, received_after: #{@received_after}, received_before:"\
-      " #{@received_before}, 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} page: #{@page.inspect}, page_size: #{@page_size.inspect}, load_numbers:"\
-      " #{@load_numbers.inspect}, invoice_numbers: #{@invoice_numbers.inspect}, statuses:"\
-      " #{@statuses.inspect}, carrier_names: #{@carrier_names.inspect}, carrier_dot_numbers:"\
-      " #{@carrier_dot_numbers.inspect}, carrier_mc_numbers: #{@carrier_mc_numbers.inspect},"\
-      " last_updated_after: #{@last_updated_after.inspect}, last_updated_before:"\
-      " #{@last_updated_before.inspect}, received_after: #{@received_after.inspect},"\
-      " received_before: #{@received_before.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
+  # SearchRequest Model.
+  class SearchRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :carrier_dot_numbers
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :carrier_mc_numbers
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :carrier_names
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :invoice_numbers
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :last_updated_after
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :last_updated_before
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :load_numbers
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :page
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :page_size
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :received_after
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :received_before
+
+    # TODO: Write general description for this method
+    # @return [Array[Integer]]
+    attr_accessor :statuses
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier_dot_numbers'] = 'carrierDotNumbers'
+      @_hash['carrier_mc_numbers'] = 'carrierMcNumbers'
+      @_hash['carrier_names'] = 'carrierNames'
+      @_hash['invoice_numbers'] = 'invoiceNumbers'
+      @_hash['last_updated_after'] = 'lastUpdatedAfter'
+      @_hash['last_updated_before'] = 'lastUpdatedBefore'
+      @_hash['load_numbers'] = 'loadNumbers'
+      @_hash['page'] = 'page'
+      @_hash['page_size'] = 'pageSize'
+      @_hash['received_after'] = 'receivedAfter'
+      @_hash['received_before'] = 'receivedBefore'
+      @_hash['statuses'] = 'statuses'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier_dot_numbers
+        carrier_mc_numbers
+        carrier_names
+        invoice_numbers
+        last_updated_after
+        last_updated_before
+        load_numbers
+        page
+        page_size
+        received_after
+        received_before
+        statuses
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        carrier_dot_numbers
+        carrier_mc_numbers
+        carrier_names
+        invoice_numbers
+        last_updated_after
+        last_updated_before
+        load_numbers
+        received_after
+        received_before
+        statuses
+      ]
+    end
+
+    def initialize(carrier_dot_numbers: SKIP, carrier_mc_numbers: SKIP,
+                   carrier_names: SKIP, invoice_numbers: SKIP,
+                   last_updated_after: SKIP, last_updated_before: SKIP,
+                   load_numbers: SKIP, page: SKIP, page_size: SKIP,
+                   received_after: SKIP, received_before: SKIP, statuses: SKIP)
+      @carrier_dot_numbers = carrier_dot_numbers unless carrier_dot_numbers == SKIP
+      @carrier_mc_numbers = carrier_mc_numbers unless carrier_mc_numbers == SKIP
+      @carrier_names = carrier_names unless carrier_names == SKIP
+      @invoice_numbers = invoice_numbers unless invoice_numbers == SKIP
+      @last_updated_after = last_updated_after unless last_updated_after == SKIP
+      @last_updated_before = last_updated_before unless last_updated_before == SKIP
+      @load_numbers = load_numbers unless load_numbers == SKIP
+      @page = page unless page == SKIP
+      @page_size = page_size unless page_size == SKIP
+      @received_after = received_after unless received_after == SKIP
+      @received_before = received_before unless received_before == SKIP
+      @statuses = statuses unless statuses == 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_dot_numbers =
+        hash.key?('carrierDotNumbers') ? hash['carrierDotNumbers'] : SKIP
+      carrier_mc_numbers =
+        hash.key?('carrierMcNumbers') ? hash['carrierMcNumbers'] : SKIP
+      carrier_names = hash.key?('carrierNames') ? hash['carrierNames'] : SKIP
+      invoice_numbers =
+        hash.key?('invoiceNumbers') ? hash['invoiceNumbers'] : SKIP
+      last_updated_after = if hash.key?('lastUpdatedAfter')
+                             (DateTimeHelper.from_rfc3339(hash['lastUpdatedAfter']) if hash['lastUpdatedAfter'])
+                           else
+                             SKIP
+                           end
+      last_updated_before = if hash.key?('lastUpdatedBefore')
+                              (DateTimeHelper.from_rfc3339(hash['lastUpdatedBefore']) if hash['lastUpdatedBefore'])
+                            else
+                              SKIP
+                            end
+      load_numbers = hash.key?('loadNumbers') ? hash['loadNumbers'] : SKIP
+      page = hash.key?('page') ? hash['page'] : SKIP
+      page_size = hash.key?('pageSize') ? hash['pageSize'] : SKIP
+      received_after = if hash.key?('receivedAfter')
+                         (DateTimeHelper.from_rfc3339(hash['receivedAfter']) if hash['receivedAfter'])
+                       else
+                         SKIP
+                       end
+      received_before = if hash.key?('receivedBefore')
+                          (DateTimeHelper.from_rfc3339(hash['receivedBefore']) if hash['receivedBefore'])
+                        else
+                          SKIP
+                        end
+      statuses = hash.key?('statuses') ? hash['statuses'] : SKIP
+
+      # Create object from extracted values.
+      SearchRequest.new(carrier_dot_numbers: carrier_dot_numbers,
+                        carrier_mc_numbers: carrier_mc_numbers,
+                        carrier_names: carrier_names,
+                        invoice_numbers: invoice_numbers,
+                        last_updated_after: last_updated_after,
+                        last_updated_before: last_updated_before,
+                        load_numbers: load_numbers,
+                        page: page,
+                        page_size: page_size,
+                        received_after: received_after,
+                        received_before: received_before,
+                        statuses: statuses)
+    end
+
+    def to_custom_last_updated_after
+      DateTimeHelper.to_rfc3339(last_updated_after)
+    end
+
+    def to_custom_last_updated_before
+      DateTimeHelper.to_rfc3339(last_updated_before)
+    end
+
+    def to_custom_received_after
+      DateTimeHelper.to_rfc3339(received_after)
+    end
+
+    def to_custom_received_before
+      DateTimeHelper.to_rfc3339(received_before)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier_dot_numbers: #{@carrier_dot_numbers}, carrier_mc_numbers:"\
+      " #{@carrier_mc_numbers}, carrier_names: #{@carrier_names}, invoice_numbers:"\
+      " #{@invoice_numbers}, last_updated_after: #{@last_updated_after}, last_updated_before:"\
+      " #{@last_updated_before}, load_numbers: #{@load_numbers}, page: #{@page}, page_size:"\
+      " #{@page_size}, received_after: #{@received_after}, received_before: #{@received_before},"\
+      " statuses: #{@statuses}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier_dot_numbers: #{@carrier_dot_numbers.inspect}, carrier_mc_numbers:"\
+      " #{@carrier_mc_numbers.inspect}, carrier_names: #{@carrier_names.inspect}, invoice_numbers:"\
+      " #{@invoice_numbers.inspect}, last_updated_after: #{@last_updated_after.inspect},"\
+      " last_updated_before: #{@last_updated_before.inspect}, load_numbers:"\
+      " #{@load_numbers.inspect}, page: #{@page.inspect}, page_size: #{@page_size.inspect},"\
+      " received_after: #{@received_after.inspect}, received_before: #{@received_before.inspect},"\
+      " statuses: #{@statuses.inspect}>"
+    end
+  end
+end