apimatic-tql-sdk 0.0.1

data/lib/tql_otr_factoring_data_exchange/models/base64_document_upload_request.rb

@@ -0,0 +1,107 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # JSON request to upload a document as a base64-encoded string, linked to an
+  # invoice.
+  class Base64DocumentUploadRequest < 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
+
+    # An optional document to include with the request, encoded as a base64
+    # string.
+    # @return [Base64Document]
+    attr_accessor :document
+
+    # Arbitrary key-value metadata tags for this document.
+    # @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['document'] = 'document'
+      @_hash['tags'] = 'tags'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tags
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        document
+        tags
+      ]
+    end
+
+    def initialize(invoice_number:, document_type:, document:, 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
+      @document = document
+      @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
+      document = Base64Document.from_hash(hash['document']) if hash['document']
+      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.
+      Base64DocumentUploadRequest.new(invoice_number: invoice_number,
+                                      document_type: document_type,
+                                      document: document,
+                                      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},"\
+      " document: #{@document}, 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}, document: #{@document.inspect}, tags: #{@tags.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/base_model.rb

@@ -0,0 +1,110 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end

data/lib/tql_otr_factoring_data_exchange/models/carrier.rb

@@ -0,0 +1,98 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Carrier details associated with this invoice.
+  class Carrier < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Legal or DBA name of the carrier.
+    # @return [String]
+    attr_accessor :name
+
+    # USDOT number.
+    # @return [String]
+    attr_accessor :dot_number
+
+    # Motor Carrier (MC) number.
+    # @return [String]
+    attr_accessor :mc_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['dot_number'] = 'dotNumber'
+      @_hash['mc_number'] = 'mcNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        dot_number
+        mc_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        dot_number
+        mc_number
+      ]
+    end
+
+    def initialize(name: SKIP, dot_number: SKIP, mc_number: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @dot_number = dot_number unless dot_number == SKIP
+      @mc_number = mc_number unless mc_number == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      dot_number = hash.key?('dotNumber') ? hash['dotNumber'] : SKIP
+      mc_number = hash.key?('mcNumber') ? hash['mcNumber'] : 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.
+      Carrier.new(name: name,
+                  dot_number: dot_number,
+                  mc_number: mc_number,
+                  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} name: #{@name}, dot_number: #{@dot_number}, mc_number: #{@mc_number},"\
+      " 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} name: #{@name.inspect}, dot_number: #{@dot_number.inspect}, mc_number:"\
+      " #{@mc_number.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/carrier1.rb

@@ -0,0 +1,98 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Carrier that was assigned/unassigned.
+  class Carrier1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :carrier_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :mc_number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :dot_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier_name'] = 'carrierName'
+      @_hash['mc_number'] = 'mcNumber'
+      @_hash['dot_number'] = 'dotNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier_name
+        mc_number
+        dot_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        mc_number
+        dot_number
+      ]
+    end
+
+    def initialize(carrier_name: SKIP, mc_number: SKIP, dot_number: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @carrier_name = carrier_name unless carrier_name == SKIP
+      @mc_number = mc_number unless mc_number == SKIP
+      @dot_number = dot_number unless dot_number == 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.
+      carrier_name = hash.key?('carrierName') ? hash['carrierName'] : SKIP
+      mc_number = hash.key?('mcNumber') ? hash['mcNumber'] : SKIP
+      dot_number = hash.key?('dotNumber') ? hash['dotNumber'] : 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.
+      Carrier1.new(carrier_name: carrier_name,
+                   mc_number: mc_number,
+                   dot_number: dot_number,
+                   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} carrier_name: #{@carrier_name}, mc_number: #{@mc_number}, dot_number:"\
+      " #{@dot_number}, 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} carrier_name: #{@carrier_name.inspect}, mc_number: #{@mc_number.inspect},"\
+      " dot_number: #{@dot_number.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/carrier2.rb

@@ -0,0 +1,98 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Carrier assigned to this load.
+  class Carrier2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Legal or DBA name of the carrier.
+    # @return [String]
+    attr_accessor :carrier_name
+
+    # Motor Carrier (MC) number.
+    # @return [String]
+    attr_accessor :mc_number
+
+    # USDOT number.
+    # @return [String]
+    attr_accessor :dot_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier_name'] = 'carrierName'
+      @_hash['mc_number'] = 'mcNumber'
+      @_hash['dot_number'] = 'dotNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier_name
+        mc_number
+        dot_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        mc_number
+        dot_number
+      ]
+    end
+
+    def initialize(carrier_name: SKIP, mc_number: SKIP, dot_number: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @carrier_name = carrier_name unless carrier_name == SKIP
+      @mc_number = mc_number unless mc_number == SKIP
+      @dot_number = dot_number unless dot_number == 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.
+      carrier_name = hash.key?('carrierName') ? hash['carrierName'] : SKIP
+      mc_number = hash.key?('mcNumber') ? hash['mcNumber'] : SKIP
+      dot_number = hash.key?('dotNumber') ? hash['dotNumber'] : 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.
+      Carrier2.new(carrier_name: carrier_name,
+                   mc_number: mc_number,
+                   dot_number: dot_number,
+                   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} carrier_name: #{@carrier_name}, mc_number: #{@mc_number}, dot_number:"\
+      " #{@dot_number}, 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} carrier_name: #{@carrier_name.inspect}, mc_number: #{@mc_number.inspect},"\
+      " dot_number: #{@dot_number.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/carrier_input.rb

@@ -0,0 +1,123 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # CarrierInput Model.
+  class CarrierInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Legal or DBA name of the carrier.
+    # @return [String]
+    attr_accessor :carrier_name
+
+    # Motor Carrier (MC) number issued by [FMCSA](https://www.fmcsa.dot.gov/).
+    # @return [String]
+    attr_accessor :mc_number
+
+    # USDOT number issued by [FMCSA](https://www.fmcsa.dot.gov/).
+    # @return [String]
+    attr_accessor :dot_number
+
+    # Standard Carrier Alpha Code
+    # ([SCAC](https://nmfta.org/registration-listing/scac/)).
+    # @return [String]
+    attr_accessor :scac
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier_name'] = 'carrierName'
+      @_hash['mc_number'] = 'mcNumber'
+      @_hash['dot_number'] = 'dotNumber'
+      @_hash['scac'] = 'scac'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier_name
+        dot_number
+        scac
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        mc_number
+        dot_number
+        scac
+      ]
+    end
+
+    def initialize(mc_number:, carrier_name: SKIP, dot_number: SKIP, scac: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @carrier_name = carrier_name unless carrier_name == SKIP
+      @mc_number = mc_number
+      @dot_number = dot_number unless dot_number == 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.
+      mc_number = hash.key?('mcNumber') ? hash['mcNumber'] : nil
+      carrier_name = hash.key?('carrierName') ? hash['carrierName'] : SKIP
+      dot_number = hash.key?('dotNumber') ? hash['dotNumber'] : 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.
+      CarrierInput.new(mc_number: mc_number,
+                       carrier_name: carrier_name,
+                       dot_number: dot_number,
+                       scac: scac,
+                       additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CarrierInput | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.mc_number,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['mcNumber'],
+                            ->(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} carrier_name: #{@carrier_name}, mc_number: #{@mc_number}, dot_number:"\
+      " #{@dot_number}, 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} carrier_name: #{@carrier_name.inspect}, mc_number: #{@mc_number.inspect},"\
+      " dot_number: #{@dot_number.inspect}, scac: #{@scac.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end