apimatic-tql-sdk 0.0.1

data/lib/tql_otr_factoring_data_exchange/models/submit_invoice_response.rb

@@ -0,0 +1,107 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module TqlOtrFactoringDataExchange
+  # Acknowledgement that the invoice was accepted for processing.
+  class SubmitInvoiceResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The factoring company's invoice number (echoed back).
+    # @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 indicating when the invoice was received.
+    # @return [DateTime]
+    attr_accessor :received_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['invoice_number'] = 'invoiceNumber'
+      @_hash['status'] = 'status'
+      @_hash['received_at'] = 'receivedAt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        invoice_number
+        status
+        received_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(invoice_number: SKIP, status: SKIP, received_at: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @invoice_number = invoice_number unless invoice_number == SKIP
+      @status = status unless status == SKIP
+      @received_at = received_at unless received_at == 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'] : 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
+
+      # 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.
+      SubmitInvoiceResponse.new(invoice_number: invoice_number,
+                                status: status,
+                                received_at: received_at,
+                                additional_properties: additional_properties)
+    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} invoice_number: #{@invoice_number}, status: #{@status}, received_at:"\
+      " #{@received_at}, 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}, status: #{@status.inspect},"\
+      " received_at: #{@received_at.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/weight_unit.rb

@@ -0,0 +1,36 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Unit of measure for `weight`. Typically LBS or KG.
+  class WeightUnit
+    WEIGHT_UNIT = [
+      # TODO: Write general description for LBS
+      LBS = 'LBS'.freeze,
+
+      # TODO: Write general description for KG
+      KG = 'KG'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WEIGHT_UNIT.include?(value)
+    end
+
+    def self.from_value(value, default_value = LBS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'lbs' then LBS
+      when 'kg' then KG
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module TqlOtrFactoringDataExchange
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/tql_otr_factoring_data_exchange/utilities/file_wrapper.rb

@@ -0,0 +1,28 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file}, content_type: #{@content_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def to_inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file.inspect}, content_type: #{@content_type.inspect}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/utilities/union_type_lookup.rb

@@ -0,0 +1,29 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # The `UnionTypeLookUp` class serves as a utility class for
+  # storing and managing type combinator templates. It acts as a container for the templates
+  # used in handling various oneof/anyof instances within the sdk.
+  class UnionTypeLookUp
+    include CoreLibrary
+    # rubocop:disable Lint/RedundantCopDisableDirective, Style/HashSyntax, Layout/FirstArgumentIndentation
+    def self.union_types
+      {
+        :CarrierInput2 => AnyOf.new(
+          [
+            LeafType.new(CarrierInput),
+            LeafType.new(CarrierInput1)
+          ]
+        )
+      }
+    end
+    # rubocop:enable Lint/RedundantCopDisableDirective, Style/HashSyntax, Layout/FirstArgumentIndentation
+
+    def self.get(name)
+      UnionTypeLookUp.union_types[name]
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange.rb

@@ -0,0 +1,107 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+require 'json'
+
+require 'apimatic_core_interfaces'
+require 'apimatic_core'
+require 'apimatic_faraday_client_adapter'
+
+require_relative 'tql_otr_factoring_data_exchange/api_helper'
+require_relative 'tql_otr_factoring_data_exchange/client'
+
+# Utilities
+require_relative 'tql_otr_factoring_data_exchange/utilities/file_wrapper'
+require_relative 'tql_otr_factoring_data_exchange/utilities/date_time_helper'
+require_relative 'tql_otr_factoring_data_exchange/utilities/union_type_lookup'
+
+# Http
+require_relative 'tql_otr_factoring_data_exchange/http/api_response'
+require_relative 'tql_otr_factoring_data_exchange/http/http_call_back'
+require_relative 'tql_otr_factoring_data_exchange/http/http_method_enum'
+require_relative 'tql_otr_factoring_data_exchange/http/http_request'
+require_relative 'tql_otr_factoring_data_exchange/http/http_response'
+require_relative 'tql_otr_factoring_data_exchange/http/proxy_settings'
+
+
+# Logger
+require_relative 'tql_otr_factoring_data_exchange/logging/configuration/' \
+                 'api_logging_configuration'
+require_relative 'tql_otr_factoring_data_exchange/logging/sdk_logger'
+require_relative 'tql_otr_factoring_data_exchange/http/auth/oauth_2'
+
+# Models
+require_relative 'tql_otr_factoring_data_exchange/models/base_model'
+require_relative 'tql_otr_factoring_data_exchange/models/charge_code'
+require_relative 'tql_otr_factoring_data_exchange/models/submit_invoice_request'
+require_relative 'tql_otr_factoring_data_exchange/models/' \
+                 'submit_invoice_response'
+require_relative 'tql_otr_factoring_data_exchange/models/' \
+                 'invoice_status_response'
+require_relative 'tql_otr_factoring_data_exchange/models/invoice_exception'
+require_relative 'tql_otr_factoring_data_exchange/models/invoice_search_request'
+require_relative 'tql_otr_factoring_data_exchange/models/' \
+                 'invoice_search_response'
+require_relative 'tql_otr_factoring_data_exchange/models/invoice'
+require_relative 'tql_otr_factoring_data_exchange/models/charge_input'
+require_relative 'tql_otr_factoring_data_exchange/models/invoice_item_input'
+require_relative 'tql_otr_factoring_data_exchange/models/assignment_request'
+require_relative 'tql_otr_factoring_data_exchange/models/assignment_response'
+require_relative 'tql_otr_factoring_data_exchange/models/' \
+                 'document_upload_metadata'
+require_relative 'tql_otr_factoring_data_exchange/models/' \
+                 'document_upload_response'
+require_relative 'tql_otr_factoring_data_exchange/models/base64_document'
+require_relative 'tql_otr_factoring_data_exchange/models/' \
+                 'base64_document_upload_request'
+require_relative 'tql_otr_factoring_data_exchange/models/load_detail'
+require_relative 'tql_otr_factoring_data_exchange/models/load_search_request'
+require_relative 'tql_otr_factoring_data_exchange/models/load_search_response'
+require_relative 'tql_otr_factoring_data_exchange/models/' \
+                 'factoring_company_input'
+require_relative 'tql_otr_factoring_data_exchange/models/stop_input'
+require_relative 'tql_otr_factoring_data_exchange/models/reference_number_input'
+require_relative 'tql_otr_factoring_data_exchange/models/problem_details'
+require_relative 'tql_otr_factoring_data_exchange/models/carrier'
+require_relative 'tql_otr_factoring_data_exchange/models/carrier1'
+require_relative 'tql_otr_factoring_data_exchange/models/carrier2'
+require_relative 'tql_otr_factoring_data_exchange/models/carrier_input'
+require_relative 'tql_otr_factoring_data_exchange/models/carrier_input1'
+require_relative 'tql_otr_factoring_data_exchange/models/document'
+require_relative 'tql_otr_factoring_data_exchange/models/load'
+require_relative 'tql_otr_factoring_data_exchange/models/location'
+require_relative 'tql_otr_factoring_data_exchange/models/payment'
+require_relative 'tql_otr_factoring_data_exchange/models/oauth_token'
+require_relative 'tql_otr_factoring_data_exchange/models/load_status'
+require_relative 'tql_otr_factoring_data_exchange/models/stop_type'
+require_relative 'tql_otr_factoring_data_exchange/models/reference_type'
+require_relative 'tql_otr_factoring_data_exchange/models/charge_code_origin'
+require_relative 'tql_otr_factoring_data_exchange/models/document_type'
+require_relative 'tql_otr_factoring_data_exchange/models/invoice_status'
+require_relative 'tql_otr_factoring_data_exchange/models/exception_severity'
+require_relative 'tql_otr_factoring_data_exchange/models/invoice_type'
+require_relative 'tql_otr_factoring_data_exchange/models/assignment_status'
+require_relative 'tql_otr_factoring_data_exchange/models/status'
+require_relative 'tql_otr_factoring_data_exchange/models/weight_unit'
+require_relative 'tql_otr_factoring_data_exchange/models/oauth_provider_error'
+require_relative 'tql_otr_factoring_data_exchange/models/oauth_scope'
+
+# Exceptions
+require_relative 'tql_otr_factoring_data_exchange/exceptions/api_exception'
+require_relative 'tql_otr_factoring_data_exchange/exceptions/' \
+                 'problem_details_error_exception'
+require_relative 'tql_otr_factoring_data_exchange/exceptions/' \
+                 'oauth_provider_exception'
+
+require_relative 'tql_otr_factoring_data_exchange/configuration'
+
+# Controllers
+require_relative 'tql_otr_factoring_data_exchange/apis/base_api'
+require_relative 'tql_otr_factoring_data_exchange/apis/invoices_api'
+require_relative 'tql_otr_factoring_data_exchange/apis/documents_api'
+require_relative 'tql_otr_factoring_data_exchange/apis/assignments_api'
+require_relative 'tql_otr_factoring_data_exchange/apis/loads_api'
+require_relative 'tql_otr_factoring_data_exchange/apis/oauth_authorization_api'

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: apimatic-tql-sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- developer sdksio
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: apimatic_core_interfaces
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: apimatic_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.20
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.20
+- !ruby/object:Gem::Dependency
+  name: apimatic_faraday_client_adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+description: this is a sample SDK generated by APIMatic
+email:
+- developer+sdksio@apimatic.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/console
+- lib/tql_otr_factoring_data_exchange.rb
+- lib/tql_otr_factoring_data_exchange/api_helper.rb
+- lib/tql_otr_factoring_data_exchange/apis/assignments_api.rb
+- lib/tql_otr_factoring_data_exchange/apis/base_api.rb
+- lib/tql_otr_factoring_data_exchange/apis/documents_api.rb
+- lib/tql_otr_factoring_data_exchange/apis/invoices_api.rb
+- lib/tql_otr_factoring_data_exchange/apis/loads_api.rb
+- lib/tql_otr_factoring_data_exchange/apis/oauth_authorization_api.rb
+- lib/tql_otr_factoring_data_exchange/client.rb
+- lib/tql_otr_factoring_data_exchange/configuration.rb
+- lib/tql_otr_factoring_data_exchange/exceptions/api_exception.rb
+- lib/tql_otr_factoring_data_exchange/exceptions/oauth_provider_exception.rb
+- lib/tql_otr_factoring_data_exchange/exceptions/problem_details_error_exception.rb
+- lib/tql_otr_factoring_data_exchange/http/api_response.rb
+- lib/tql_otr_factoring_data_exchange/http/auth/oauth_2.rb
+- lib/tql_otr_factoring_data_exchange/http/http_call_back.rb
+- lib/tql_otr_factoring_data_exchange/http/http_method_enum.rb
+- lib/tql_otr_factoring_data_exchange/http/http_request.rb
+- lib/tql_otr_factoring_data_exchange/http/http_response.rb
+- lib/tql_otr_factoring_data_exchange/http/proxy_settings.rb
+- lib/tql_otr_factoring_data_exchange/logging/configuration/api_logging_configuration.rb
+- lib/tql_otr_factoring_data_exchange/logging/sdk_logger.rb
+- lib/tql_otr_factoring_data_exchange/models/assignment_request.rb
+- lib/tql_otr_factoring_data_exchange/models/assignment_response.rb
+- lib/tql_otr_factoring_data_exchange/models/assignment_status.rb
+- lib/tql_otr_factoring_data_exchange/models/base64_document.rb
+- lib/tql_otr_factoring_data_exchange/models/base64_document_upload_request.rb
+- lib/tql_otr_factoring_data_exchange/models/base_model.rb
+- lib/tql_otr_factoring_data_exchange/models/carrier.rb
+- lib/tql_otr_factoring_data_exchange/models/carrier1.rb
+- lib/tql_otr_factoring_data_exchange/models/carrier2.rb
+- lib/tql_otr_factoring_data_exchange/models/carrier_input.rb
+- lib/tql_otr_factoring_data_exchange/models/carrier_input1.rb
+- lib/tql_otr_factoring_data_exchange/models/charge_code.rb
+- lib/tql_otr_factoring_data_exchange/models/charge_code_origin.rb
+- lib/tql_otr_factoring_data_exchange/models/charge_input.rb
+- lib/tql_otr_factoring_data_exchange/models/document.rb
+- lib/tql_otr_factoring_data_exchange/models/document_type.rb
+- lib/tql_otr_factoring_data_exchange/models/document_upload_metadata.rb
+- lib/tql_otr_factoring_data_exchange/models/document_upload_response.rb
+- lib/tql_otr_factoring_data_exchange/models/exception_severity.rb
+- lib/tql_otr_factoring_data_exchange/models/factoring_company_input.rb
+- lib/tql_otr_factoring_data_exchange/models/invoice.rb
+- lib/tql_otr_factoring_data_exchange/models/invoice_exception.rb
+- lib/tql_otr_factoring_data_exchange/models/invoice_item_input.rb
+- lib/tql_otr_factoring_data_exchange/models/invoice_search_request.rb
+- lib/tql_otr_factoring_data_exchange/models/invoice_search_response.rb
+- lib/tql_otr_factoring_data_exchange/models/invoice_status.rb
+- lib/tql_otr_factoring_data_exchange/models/invoice_status_response.rb
+- lib/tql_otr_factoring_data_exchange/models/invoice_type.rb
+- lib/tql_otr_factoring_data_exchange/models/load.rb
+- lib/tql_otr_factoring_data_exchange/models/load_detail.rb
+- lib/tql_otr_factoring_data_exchange/models/load_search_request.rb
+- lib/tql_otr_factoring_data_exchange/models/load_search_response.rb
+- lib/tql_otr_factoring_data_exchange/models/load_status.rb
+- lib/tql_otr_factoring_data_exchange/models/location.rb
+- lib/tql_otr_factoring_data_exchange/models/oauth_provider_error.rb
+- lib/tql_otr_factoring_data_exchange/models/oauth_scope.rb
+- lib/tql_otr_factoring_data_exchange/models/oauth_token.rb
+- lib/tql_otr_factoring_data_exchange/models/payment.rb
+- lib/tql_otr_factoring_data_exchange/models/problem_details.rb
+- lib/tql_otr_factoring_data_exchange/models/reference_number_input.rb
+- lib/tql_otr_factoring_data_exchange/models/reference_type.rb
+- lib/tql_otr_factoring_data_exchange/models/status.rb
+- lib/tql_otr_factoring_data_exchange/models/stop_input.rb
+- lib/tql_otr_factoring_data_exchange/models/stop_type.rb
+- lib/tql_otr_factoring_data_exchange/models/submit_invoice_request.rb
+- lib/tql_otr_factoring_data_exchange/models/submit_invoice_response.rb
+- lib/tql_otr_factoring_data_exchange/models/weight_unit.rb
+- lib/tql_otr_factoring_data_exchange/utilities/date_time_helper.rb
+- lib/tql_otr_factoring_data_exchange/utilities/file_wrapper.rb
+- lib/tql_otr_factoring_data_exchange/utilities/union_type_lookup.rb
+homepage: https://apimatic.io
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: this is a sample SDK generated by APIMatic
+test_files: []