apimatic-tql-sdk 0.0.1 → 0.0.2

data/lib/tql_otr_factoring_data_exchange/models/assignment_request.rb

@@ -1,140 +0,0 @@
-# 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_status.rb

@@ -1,36 +0,0 @@
-# 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

@@ -1,118 +0,0 @@
-# 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

data/lib/tql_otr_factoring_data_exchange/models/base64_document_upload_request.rb

@@ -1,107 +0,0 @@
-# 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/carrier.rb

@@ -1,98 +0,0 @@
-# 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/carrier2.rb

@@ -1,98 +0,0 @@
-# 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