apimatic-tql-sdk 0.0.1

data/lib/tql_otr_factoring_data_exchange/http/proxy_settings.rb

@@ -0,0 +1,22 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+    def self.from_env
+      address = ENV['PROXY_ADDRESS']
+      port = ENV['PROXY_PORT']
+      username = ENV['PROXY_USERNAME']
+      password = ENV['PROXY_PASSWORD']
+      return nil if address.nil? || address.strip.empty?
+
+      new(address: address, port: port, username: username, password: password)
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/logging/configuration/api_logging_configuration.rb

@@ -0,0 +1,186 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Initializes a new instance of RequestLoggingConfiguration.
+  class RequestLoggingConfiguration < CoreLibrary::ApiRequestLoggingConfiguration
+    # @param log_body [Boolean] Indicates whether the message body should be logged. Default is false.
+    # @param log_headers [Boolean] Indicates whether the message headers should be logged. Default is false.
+    # @param headers_to_exclude [Array<String>] Array of headers not displayed in logging. Default is an empty array.
+    # @param headers_to_include [Array<String>] Array of headers to be displayed in logging. Default is an empty array.
+    # @param headers_to_unmask [Array<String>] Array of headers which values are non-sensitive to display in logging.
+    #   Default is an empty array.
+    def initialize(log_body: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil,
+                   include_query_in_path: false)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask,
+        include_query_in_path
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil, include_query_in_path: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+      include_query_in_path ||= self.include_query_in_path
+
+      RequestLoggingConfiguration.new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask,
+        include_query_in_path: include_query_in_path
+      )
+    end
+
+    def self.from_env
+      log_body = ENV['REQUEST_LOG_BODY']
+      log_headers = ENV['REQUEST_LOG_HEADERS']
+      headers_to_include = ENV['REQUEST_HEADERS_TO_INCLUDE']
+      headers_to_exclude = ENV['REQUEST_HEADERS_TO_EXCLUDE']
+      headers_to_unmask = ENV['REQUEST_HEADERS_TO_UNMASK']
+      include_query_in_path = ENV['REQUEST_INCLUDE_QUERY_IN_PATH']
+
+      new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask,
+        include_query_in_path: include_query_in_path
+      )
+    end
+
+    def self.any_logging_configured?
+      %w[
+        REQUEST_LOG_BODY
+        REQUEST_LOG_HEADERS
+        REQUEST_HEADERS_TO_INCLUDE
+        REQUEST_HEADERS_TO_EXCLUDE
+        REQUEST_HEADERS_TO_UNMASK
+        REQUEST_INCLUDE_QUERY_IN_PATH
+      ].any? { |key| ENV.key?(key) && !ENV[key].nil? && !ENV[key].empty? }
+    end
+  end
+
+  # Initializes a new instance of ResponseLoggingConfiguration.
+  class ResponseLoggingConfiguration < CoreLibrary::ApiResponseLoggingConfiguration
+    def initialize(log_body: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+
+      ResponseLoggingConfiguration.new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask
+      )
+    end
+
+    def self.from_env
+      log_body = ENV['RESPONSE_LOG_BODY']
+      log_headers = ENV['RESPONSE_LOG_HEADERS']
+      headers_to_include = ENV['RESPONSE_HEADERS_TO_INCLUDE']
+      headers_to_exclude = ENV['RESPONSE_HEADERS_TO_EXCLUDE']
+      headers_to_unmask = ENV['RESPONSE_HEADERS_TO_UNMASK']
+
+      new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask
+      )
+    end
+
+    def self.any_logging_configured?
+      %w[
+        RESPONSE_LOG_BODY
+        RESPONSE_LOG_HEADERS
+        RESPONSE_HEADERS_TO_INCLUDE
+        RESPONSE_HEADERS_TO_EXCLUDE
+        RESPONSE_HEADERS_TO_UNMASK
+      ].any? { |key| ENV.key?(key) && !ENV[key].nil? && !ENV[key].empty? }
+    end
+  end
+
+  # Initializes a new instance of LoggingConfiguration.
+  class LoggingConfiguration < CoreLibrary::ApiLoggingConfiguration
+    def initialize(logger: nil, log_level: nil, mask_sensitive_headers: true,
+                   request_logging_config: nil,
+                   response_logging_config: nil)
+      request_logging_config ||= RequestLoggingConfiguration.new
+      response_logging_config ||= ResponseLoggingConfiguration.new
+      super(
+        logger,
+        log_level,
+        request_logging_config,
+        response_logging_config,
+        mask_sensitive_headers
+      )
+    end
+
+    def clone_with(logger: nil, log_level: nil, mask_sensitive_headers: nil,
+                   request_logging_config: nil, response_logging_config: nil)
+      logger ||= self.logger
+      log_level ||= self.log_level
+      mask_sensitive_headers ||= self.mask_sensitive_headers
+      request_logging_config ||= self.request_logging_config.clone
+      response_logging_config ||= self.response_logging_config.clone
+
+      LoggingConfiguration.new(
+        logger: logger,
+        log_level: log_level,
+        mask_sensitive_headers: mask_sensitive_headers,
+        request_logging_config: request_logging_config,
+        response_logging_config: response_logging_config
+      )
+    end
+
+    def self.from_env
+      log_level = ENV['LOG_LEVEL']
+      mask_sensitive_headers = ENV['MASK_SENSITIVE_HEADERS']
+
+      new(
+        log_level: log_level,
+        mask_sensitive_headers: mask_sensitive_headers,
+        request_logging_config: RequestLoggingConfiguration.from_env,
+        response_logging_config: ResponseLoggingConfiguration.from_env
+      )
+    end
+
+    def self.any_logging_configured?
+      RequestLoggingConfiguration.any_logging_configured? ||
+        ResponseLoggingConfiguration.any_logging_configured? ||
+        ENV.key?('LOG_LEVEL') ||
+        ENV.key?('MASK_SENSITIVE_HEADERS')
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/logging/sdk_logger.rb

@@ -0,0 +1,17 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Represents the generic logger facade
+  class AbstractLogger < Logger
+    # Logs a message with a specified log level and additional parameters.
+    # @param level [Symbol] The log level of the message.
+    # @param message [String] The message to log.
+    # @param params [Hash] Additional parameters to include in the log message.
+    def log(level, message, params)
+      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/assignment_request.rb

@@ -0,0 +1,140 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # Request to assign or unassign a factoring company from a carrier. The
+  # carrier is identified by `carrier`. The `effectiveDate` indicates when the
+  # assignment or un-assignment took effect.
+  class AssignmentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Carrier information for the invoiced shipment. At least one of `mcNumber`
+    # or `dotNumber` must be provided.
+    # @return [Object]
+    attr_accessor :carrier
+
+    # Whether the factoring company is assigned to or unassigned from the
+    # carrier.
+    # @return [AssignmentStatus]
+    attr_accessor :status
+
+    # The date the assignment or un-assignment took effect ("as of" date). [ISO
+    # 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date format
+    # (YYYY-MM-DD).
+    # @return [Date]
+    attr_accessor :effective_date
+
+    # An optional document to include with the request, encoded as a base64
+    # string.
+    # @return [Base64Document]
+    attr_accessor :document
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier'] = 'carrier'
+      @_hash['status'] = 'status'
+      @_hash['effective_date'] = 'effectiveDate'
+      @_hash['document'] = 'document'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        document
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        document
+      ]
+    end
+
+    def initialize(carrier:, status:, effective_date:, document: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @carrier = carrier
+      @status = status
+      @effective_date = effective_date
+      @document = document unless document == 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 = hash.key?('carrier') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CarrierInput2), hash['carrier']
+      ) : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      effective_date = hash.key?('effectiveDate') ? hash['effectiveDate'] : nil
+      document = Base64Document.from_hash(hash['document']) if hash['document']
+
+      # 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.
+      AssignmentRequest.new(carrier: carrier,
+                            status: status,
+                            effective_date: effective_date,
+                            document: document,
+                            additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AssignmentRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:CarrierInput2)
+                         .validate(value.carrier) and
+            APIHelper.valid_type?(value.status,
+                                  ->(val) { AssignmentStatus.validate(val) }) and
+            APIHelper.valid_type?(value.effective_date,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:CarrierInput2)
+                       .validate(value['carrier']) and
+          APIHelper.valid_type?(value['status'],
+                                ->(val) { AssignmentStatus.validate(val) }) and
+          APIHelper.valid_type?(value['effectiveDate'],
+                                ->(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: #{@carrier}, status: #{@status}, effective_date:"\
+      " #{@effective_date}, document: #{@document}, 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: #{@carrier.inspect}, status: #{@status.inspect}, effective_date:"\
+      " #{@effective_date.inspect}, document: #{@document.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/assignment_response.rb

@@ -0,0 +1,126 @@
+# 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 assignment was recorded.
+  class AssignmentResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # System-generated unique identifier for this assignment record.
+    # @return [UUID | String]
+    attr_accessor :assignment_id
+
+    # Carrier that was assigned/unassigned.
+    # @return [Carrier1]
+    attr_accessor :carrier
+
+    # Whether the factoring company is assigned to or unassigned from the
+    # carrier.
+    # @return [AssignmentStatus]
+    attr_accessor :status
+
+    # The effective date that was recorded.
+    # @return [Date]
+    attr_accessor :effective_date
+
+    # UTC timestamp when TQL recorded this assignment.
+    # @return [DateTime]
+    attr_accessor :recorded_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['assignment_id'] = 'assignmentId'
+      @_hash['carrier'] = 'carrier'
+      @_hash['status'] = 'status'
+      @_hash['effective_date'] = 'effectiveDate'
+      @_hash['recorded_at'] = 'recordedAt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        assignment_id
+        carrier
+        status
+        effective_date
+        recorded_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(assignment_id: SKIP, carrier: SKIP, status: SKIP,
+                   effective_date: SKIP, recorded_at: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @assignment_id = assignment_id unless assignment_id == SKIP
+      @carrier = carrier unless carrier == SKIP
+      @status = status unless status == SKIP
+      @effective_date = effective_date unless effective_date == SKIP
+      @recorded_at = recorded_at unless recorded_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.
+      assignment_id = hash.key?('assignmentId') ? hash['assignmentId'] : SKIP
+      carrier = Carrier1.from_hash(hash['carrier']) if hash['carrier']
+      status = hash.key?('status') ? hash['status'] : SKIP
+      effective_date = hash.key?('effectiveDate') ? hash['effectiveDate'] : SKIP
+      recorded_at = if hash.key?('recordedAt')
+                      (DateTimeHelper.from_rfc3339(hash['recordedAt']) if hash['recordedAt'])
+                    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.
+      AssignmentResponse.new(assignment_id: assignment_id,
+                             carrier: carrier,
+                             status: status,
+                             effective_date: effective_date,
+                             recorded_at: recorded_at,
+                             additional_properties: additional_properties)
+    end
+
+    def to_custom_recorded_at
+      DateTimeHelper.to_rfc3339(recorded_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} assignment_id: #{@assignment_id}, carrier: #{@carrier}, status: #{@status},"\
+      " effective_date: #{@effective_date}, recorded_at: #{@recorded_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} assignment_id: #{@assignment_id.inspect}, carrier: #{@carrier.inspect},"\
+      " status: #{@status.inspect}, effective_date: #{@effective_date.inspect}, recorded_at:"\
+      " #{@recorded_at.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/assignment_status.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
+  # Whether the factoring company is assigned to or unassigned from the carrier.
+  class AssignmentStatus
+    ASSIGNMENT_STATUS = [
+      # TODO: Write general description for ASSIGNED
+      ASSIGNED = 'Assigned'.freeze,
+
+      # TODO: Write general description for UNASSIGNED
+      UNASSIGNED = 'Unassigned'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ASSIGNMENT_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = ASSIGNED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'assigned' then ASSIGNED
+      when 'unassigned' then UNASSIGNED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/models/base64_document.rb

@@ -0,0 +1,118 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # An optional document to include with the request, encoded as a base64
+  # string.
+  class Base64Document < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Base64-encoded document content.
+    # @return [String]
+    attr_accessor :content
+
+    # Original file name including extension.
+    # @return [String]
+    attr_accessor :file_name
+
+    # MIME type of the document.
+    # @return [String]
+    attr_accessor :content_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['content'] = 'content'
+      @_hash['file_name'] = 'fileName'
+      @_hash['content_type'] = 'contentType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(content:, file_name:, content_type:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @content = content
+      @file_name = file_name
+      @content_type = content_type
+      @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.
+      content = hash.key?('content') ? hash['content'] : nil
+      file_name = hash.key?('fileName') ? hash['fileName'] : nil
+      content_type = hash.key?('contentType') ? hash['contentType'] : nil
+
+      # 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.
+      Base64Document.new(content: content,
+                         file_name: file_name,
+                         content_type: content_type,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Base64Document | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.content,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.file_name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.content_type,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['content'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['fileName'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['contentType'],
+                                ->(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} content: #{@content}, file_name: #{@file_name}, content_type:"\
+      " #{@content_type}, 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} content: #{@content.inspect}, file_name: #{@file_name.inspect},"\
+      " content_type: #{@content_type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end