apimatic-tql-sdk 0.0.1 → 0.0.2

data/lib/tql_otr_factoring_data_exchange/models/submit_invoice_request.rb

@@ -1,326 +0,0 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-module TqlOtrFactoringDataExchange
-  # Factoring company invoice submitted against a TQL load. Documents should be
-  # uploaded separately via `POST /api/documents`.
-  class SubmitInvoiceRequest < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # Indicates the purpose of the invoice being submitted.
-    # - **Invoice** — A standard carrier invoice for freight services
-    #   rendered on a load. This is the initial, primary billing
-    #   submitted by the factoring company on behalf of the carrier.
-    # - **BalanceDue** — A follow-up invoice for the remaining balance
-    #   after a partial payment or short-pay on a previously submitted
-    #   invoice. Use this type when the original invoice was paid at
-    #   less than the full amount and the carrier is billing for the
-    #   difference.
-    # - **Supplemental** — An additional invoice for charges that were
-    #   not included on the original invoice. Common examples include
-    #   detention charges, lumper fees, or other accessorials
-    #   discovered or finalized after the initial invoice was
-    #   submitted.
-    # @return [InvoiceType]
-    attr_accessor :type
-
-    # The TQL load number this invoice is billed against. This is the load
-    # identifier assigned by TQL and must match an existing load in the TQL
-    # system.
-    # @return [String]
-    attr_accessor :load_number
-
-    # The factoring company's invoice number for this shipment. This is the
-    # primary identifier the factoring company uses to track this invoice.
-    # @return [String]
-    attr_accessor :invoice_number
-
-    # The carrier's own invoice number, if different from the factoring
-    # company's invoice number. Optional.
-    # @return [String]
-    attr_accessor :carrier_invoice_number
-
-    # Carrier information for the invoiced shipment. At least one of `mcNumber`
-    # or `dotNumber` must be provided.
-    # @return [Object]
-    attr_accessor :carrier
-
-    # Identifies the factoring company that purchased (bought out) the carrier's
-    # loads.
-    # @return [FactoringCompanyInput]
-    attr_accessor :factoring_company
-
-    # Ordered list of stops for the invoiced shipment. Must include at least an
-    # origin and a destination.
-    # @return [Array[StopInput]]
-    attr_accessor :stops
-
-    # One or more carrier charge line items on this invoice.
-    # @return [Array[ChargeInput]]
-    attr_accessor :charges
-
-    # Physical line items describing the freight being shipped. Each item
-    # represents a distinct commodity or handling unit on the load — for
-    # example, 4 pallets of paper towels at 2,310 lbs, freight class 100. Items
-    # describe **what was moved**; charges describe **what you are billing**.
-    # These are independent concepts — charges are not linked to specific items.
-    # @return [Array[InvoiceItemInput]]
-    attr_accessor :items
-
-    # One or more reference numbers (PRO, PO, BOL, etc.) to cross-reference this
-    # invoice with the TQL load.
-    # @return [Array[ReferenceNumberInput]]
-    attr_accessor :reference_numbers
-
-    # Date the invoice was generated or sent by the factoring company. [ISO
-    # 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date format
-    # (YYYY-MM-DD).
-    # @return [Date]
-    attr_accessor :invoice_date
-
-    # Date by which the invoice should be paid, if known. [ISO
-    # 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date format
-    # (YYYY-MM-DD).
-    # @return [Date]
-    attr_accessor :invoice_due_date
-
-    # Invoice payment terms. Use `NetN` where N is the number of days until
-    # payment is due (0–365), or `Prepaid` for invoices paid in advance.
-    # @return [String]
-    attr_accessor :payment_terms
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['type'] = 'type'
-      @_hash['load_number'] = 'loadNumber'
-      @_hash['invoice_number'] = 'invoiceNumber'
-      @_hash['carrier_invoice_number'] = 'carrierInvoiceNumber'
-      @_hash['carrier'] = 'carrier'
-      @_hash['factoring_company'] = 'factoringCompany'
-      @_hash['stops'] = 'stops'
-      @_hash['charges'] = 'charges'
-      @_hash['items'] = 'items'
-      @_hash['reference_numbers'] = 'referenceNumbers'
-      @_hash['invoice_date'] = 'invoiceDate'
-      @_hash['invoice_due_date'] = 'invoiceDueDate'
-      @_hash['payment_terms'] = 'paymentTerms'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        type
-        carrier_invoice_number
-        items
-        invoice_due_date
-        payment_terms
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      %w[
-        carrier_invoice_number
-        items
-        invoice_due_date
-        payment_terms
-      ]
-    end
-
-    def initialize(load_number:, invoice_number:, carrier:, factoring_company:,
-                   stops:, charges:, reference_numbers:, invoice_date:,
-                   type: InvoiceType::INVOICE, carrier_invoice_number: SKIP,
-                   items: SKIP, invoice_due_date: SKIP, payment_terms: SKIP,
-                   additional_properties: nil)
-      # Add additional model properties to the instance
-      additional_properties = {} if additional_properties.nil?
-
-      @type = type unless type == SKIP
-      @load_number = load_number
-      @invoice_number = invoice_number
-      @carrier_invoice_number = carrier_invoice_number unless carrier_invoice_number == SKIP
-      @carrier = carrier
-      @factoring_company = factoring_company
-      @stops = stops
-      @charges = charges
-      @items = items unless items == SKIP
-      @reference_numbers = reference_numbers
-      @invoice_date = invoice_date
-      @invoice_due_date = invoice_due_date unless invoice_due_date == SKIP
-      @payment_terms = payment_terms unless payment_terms == 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.
-      load_number = hash.key?('loadNumber') ? hash['loadNumber'] : nil
-      invoice_number = hash.key?('invoiceNumber') ? hash['invoiceNumber'] : nil
-      carrier = hash.key?('carrier') ? APIHelper.deserialize_union_type(
-        UnionTypeLookUp.get(:CarrierInput2), hash['carrier']
-      ) : nil
-      factoring_company = FactoringCompanyInput.from_hash(hash['factoringCompany']) if
-        hash['factoringCompany']
-      # Parameter is an array, so we need to iterate through it
-      stops = nil
-      unless hash['stops'].nil?
-        stops = []
-        hash['stops'].each do |structure|
-          stops << (StopInput.from_hash(structure) if structure)
-        end
-      end
-
-      stops = nil unless hash.key?('stops')
-      # Parameter is an array, so we need to iterate through it
-      charges = nil
-      unless hash['charges'].nil?
-        charges = []
-        hash['charges'].each do |structure|
-          charges << (ChargeInput.from_hash(structure) if structure)
-        end
-      end
-
-      charges = nil unless hash.key?('charges')
-      # Parameter is an array, so we need to iterate through it
-      reference_numbers = nil
-      unless hash['referenceNumbers'].nil?
-        reference_numbers = []
-        hash['referenceNumbers'].each do |structure|
-          reference_numbers << (ReferenceNumberInput.from_hash(structure) if structure)
-        end
-      end
-
-      reference_numbers = nil unless hash.key?('referenceNumbers')
-      invoice_date = hash.key?('invoiceDate') ? hash['invoiceDate'] : nil
-      type = hash['type'] ||= InvoiceType::INVOICE
-      carrier_invoice_number =
-        hash.key?('carrierInvoiceNumber') ? hash['carrierInvoiceNumber'] : SKIP
-      # Parameter is an array, so we need to iterate through it
-      items = nil
-      unless hash['items'].nil?
-        items = []
-        hash['items'].each do |structure|
-          items << (InvoiceItemInput.from_hash(structure) if structure)
-        end
-      end
-
-      items = SKIP unless hash.key?('items')
-      invoice_due_date =
-        hash.key?('invoiceDueDate') ? hash['invoiceDueDate'] : SKIP
-      payment_terms = hash.key?('paymentTerms') ? hash['paymentTerms'] : 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.
-      SubmitInvoiceRequest.new(load_number: load_number,
-                               invoice_number: invoice_number,
-                               carrier: carrier,
-                               factoring_company: factoring_company,
-                               stops: stops,
-                               charges: charges,
-                               reference_numbers: reference_numbers,
-                               invoice_date: invoice_date,
-                               type: type,
-                               carrier_invoice_number: carrier_invoice_number,
-                               items: items,
-                               invoice_due_date: invoice_due_date,
-                               payment_terms: payment_terms,
-                               additional_properties: additional_properties)
-    end
-
-    # Validates an instance of the object from a given value.
-    # @param [SubmitInvoiceRequest | Hash] The value against the validation is performed.
-    def self.validate(value)
-      if value.instance_of? self
-        return (
-          APIHelper.valid_type?(value.load_number,
-                                ->(val) { val.instance_of? String }) and
-            APIHelper.valid_type?(value.invoice_number,
-                                  ->(val) { val.instance_of? String }) and
-            UnionTypeLookUp.get(:CarrierInput2)
-                           .validate(value.carrier) and
-            APIHelper.valid_type?(value.factoring_company,
-                                  ->(val) { FactoringCompanyInput.validate(val) },
-                                  is_model_hash: true) and
-            APIHelper.valid_type?(value.stops,
-                                  ->(val) { StopInput.validate(val) },
-                                  is_model_hash: true,
-                                  is_inner_model_hash: true) and
-            APIHelper.valid_type?(value.charges,
-                                  ->(val) { ChargeInput.validate(val) },
-                                  is_model_hash: true,
-                                  is_inner_model_hash: true) and
-            APIHelper.valid_type?(value.reference_numbers,
-                                  ->(val) { ReferenceNumberInput.validate(val) },
-                                  is_model_hash: true,
-                                  is_inner_model_hash: true) and
-            APIHelper.valid_type?(value.invoice_date,
-                                  ->(val) { val.instance_of? String })
-        )
-      end
-
-      return false unless value.instance_of? Hash
-
-      (
-        APIHelper.valid_type?(value['loadNumber'],
-                              ->(val) { val.instance_of? String }) and
-          APIHelper.valid_type?(value['invoiceNumber'],
-                                ->(val) { val.instance_of? String }) and
-          UnionTypeLookUp.get(:CarrierInput2)
-                         .validate(value['carrier']) and
-          APIHelper.valid_type?(value['factoringCompany'],
-                                ->(val) { FactoringCompanyInput.validate(val) },
-                                is_model_hash: true) and
-          APIHelper.valid_type?(value['stops'],
-                                ->(val) { StopInput.validate(val) },
-                                is_model_hash: true,
-                                is_inner_model_hash: true) and
-          APIHelper.valid_type?(value['charges'],
-                                ->(val) { ChargeInput.validate(val) },
-                                is_model_hash: true,
-                                is_inner_model_hash: true) and
-          APIHelper.valid_type?(value['referenceNumbers'],
-                                ->(val) { ReferenceNumberInput.validate(val) },
-                                is_model_hash: true,
-                                is_inner_model_hash: true) and
-          APIHelper.valid_type?(value['invoiceDate'],
-                                ->(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} type: #{@type}, load_number: #{@load_number}, invoice_number:"\
-      " #{@invoice_number}, carrier_invoice_number: #{@carrier_invoice_number}, carrier:"\
-      " #{@carrier}, factoring_company: #{@factoring_company}, stops: #{@stops}, charges:"\
-      " #{@charges}, items: #{@items}, reference_numbers: #{@reference_numbers}, invoice_date:"\
-      " #{@invoice_date}, invoice_due_date: #{@invoice_due_date}, payment_terms:"\
-      " #{@payment_terms}, 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} type: #{@type.inspect}, load_number: #{@load_number.inspect},"\
-      " invoice_number: #{@invoice_number.inspect}, carrier_invoice_number:"\
-      " #{@carrier_invoice_number.inspect}, carrier: #{@carrier.inspect}, factoring_company:"\
-      " #{@factoring_company.inspect}, stops: #{@stops.inspect}, charges: #{@charges.inspect},"\
-      " items: #{@items.inspect}, reference_numbers: #{@reference_numbers.inspect}, invoice_date:"\
-      " #{@invoice_date.inspect}, invoice_due_date: #{@invoice_due_date.inspect}, payment_terms:"\
-      " #{@payment_terms.inspect}, additional_properties: #{@additional_properties}>"
-    end
-  end
-end

data/lib/tql_otr_factoring_data_exchange/models/weight_unit.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
-  # 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

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

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

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