apimatic-tql-sdk 0.0.1 → 0.0.2

data/lib/tql_otr_factoring_data_exchange/models/load_search_response.rb

@@ -1,124 +0,0 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-module TqlOtrFactoringDataExchange
-  # Paginated list of load search results.
-  class LoadSearchResponse < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # Current page number.
-    # @return [Integer]
-    attr_accessor :page
-
-    # Number of results per page.
-    # @return [Integer]
-    attr_accessor :page_size
-
-    # Total number of loads matching the search criteria.
-    # @return [Integer]
-    attr_accessor :total_count
-
-    # Total number of pages.
-    # @return [Integer]
-    attr_accessor :total_pages
-
-    # Loads matching the search criteria for this page.
-    # @return [Array[LoadDetail]]
-    attr_accessor :results
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['page'] = 'page'
-      @_hash['page_size'] = 'pageSize'
-      @_hash['total_count'] = 'totalCount'
-      @_hash['total_pages'] = 'totalPages'
-      @_hash['results'] = 'results'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        page
-        page_size
-        total_count
-        total_pages
-        results
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(page: SKIP, page_size: SKIP, total_count: SKIP,
-                   total_pages: SKIP, results: SKIP, additional_properties: nil)
-      # Add additional model properties to the instance
-      additional_properties = {} if additional_properties.nil?
-
-      @page = page unless page == SKIP
-      @page_size = page_size unless page_size == SKIP
-      @total_count = total_count unless total_count == SKIP
-      @total_pages = total_pages unless total_pages == SKIP
-      @results = results unless results == 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.
-      page = hash.key?('page') ? hash['page'] : SKIP
-      page_size = hash.key?('pageSize') ? hash['pageSize'] : SKIP
-      total_count = hash.key?('totalCount') ? hash['totalCount'] : SKIP
-      total_pages = hash.key?('totalPages') ? hash['totalPages'] : SKIP
-      # Parameter is an array, so we need to iterate through it
-      results = nil
-      unless hash['results'].nil?
-        results = []
-        hash['results'].each do |structure|
-          results << (LoadDetail.from_hash(structure) if structure)
-        end
-      end
-
-      results = SKIP unless hash.key?('results')
-
-      # 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.
-      LoadSearchResponse.new(page: page,
-                             page_size: page_size,
-                             total_count: total_count,
-                             total_pages: total_pages,
-                             results: results,
-                             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} page: #{@page}, page_size: #{@page_size}, total_count: #{@total_count},"\
-      " total_pages: #{@total_pages}, results: #{@results}, 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} page: #{@page.inspect}, page_size: #{@page_size.inspect}, total_count:"\
-      " #{@total_count.inspect}, total_pages: #{@total_pages.inspect}, results:"\
-      " #{@results.inspect}, additional_properties: #{@additional_properties}>"
-    end
-  end
-end

data/lib/tql_otr_factoring_data_exchange/models/load_status.rb

@@ -1,56 +0,0 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-module TqlOtrFactoringDataExchange
-  # Current status of a TQL load.
-  class LoadStatus
-    LOAD_STATUS = [
-      # TODO: Write general description for AVAILABLE
-      AVAILABLE = 'Available'.freeze,
-
-      # TODO: Write general description for BOOKED
-      BOOKED = 'Booked'.freeze,
-
-      # TODO: Write general description for DISPATCHED
-      DISPATCHED = 'Dispatched'.freeze,
-
-      # TODO: Write general description for INTRANSIT
-      INTRANSIT = 'InTransit'.freeze,
-
-      # TODO: Write general description for DELIVERED
-      DELIVERED = 'Delivered'.freeze,
-
-      # TODO: Write general description for COMPLETED
-      COMPLETED = 'Completed'.freeze,
-
-      # TODO: Write general description for CANCELLED
-      CANCELLED = 'Cancelled'.freeze
-    ].freeze
-
-    def self.validate(value)
-      return false if value.nil?
-
-      LOAD_STATUS.include?(value)
-    end
-
-    def self.from_value(value, default_value = AVAILABLE)
-      return default_value if value.nil?
-
-      str = value.to_s.strip
-
-      case str.downcase
-      when 'available' then AVAILABLE
-      when 'booked' then BOOKED
-      when 'dispatched' then DISPATCHED
-      when 'intransit' then INTRANSIT
-      when 'delivered' then DELIVERED
-      when 'completed' then COMPLETED
-      when 'cancelled' then CANCELLED
-      else
-        default_value
-      end
-    end
-  end
-end

data/lib/tql_otr_factoring_data_exchange/models/location.rb

@@ -1,149 +0,0 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-module TqlOtrFactoringDataExchange
-  # Physical address of the stop.
-  class Location < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # Facility or company name at this stop.
-    # @return [String]
-    attr_accessor :name
-
-    # Street address line 1.
-    # @return [String]
-    attr_accessor :address
-
-    # Street address line 2 (suite, unit, dock, etc.).
-    # @return [String]
-    attr_accessor :address2
-
-    # City name.
-    # @return [String]
-    attr_accessor :city
-
-    # Two-letter state/province code.
-    # @return [String]
-    attr_accessor :state
-
-    # ZIP or postal code.
-    # @return [String]
-    attr_accessor :postal_code
-
-    # [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-2
-    # country code.
-    # @return [String]
-    attr_accessor :country
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['name'] = 'name'
-      @_hash['address'] = 'address'
-      @_hash['address2'] = 'address2'
-      @_hash['city'] = 'city'
-      @_hash['state'] = 'state'
-      @_hash['postal_code'] = 'postalCode'
-      @_hash['country'] = 'country'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        name
-        address
-        address2
-        city
-        state
-        postal_code
-        country
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      %w[
-        name
-        address2
-      ]
-    end
-
-    def initialize(name: SKIP, address: SKIP, address2: SKIP, city: SKIP,
-                   state: SKIP, postal_code: SKIP, country: 'US',
-                   additional_properties: nil)
-      # Add additional model properties to the instance
-      additional_properties = {} if additional_properties.nil?
-
-      @name = name unless name == SKIP
-      @address = address unless address == SKIP
-      @address2 = address2 unless address2 == SKIP
-      @city = city unless city == SKIP
-      @state = state unless state == SKIP
-      @postal_code = postal_code unless postal_code == SKIP
-      @country = country unless country == 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
-      address = hash.key?('address') ? hash['address'] : SKIP
-      address2 = hash.key?('address2') ? hash['address2'] : SKIP
-      city = hash.key?('city') ? hash['city'] : SKIP
-      state = hash.key?('state') ? hash['state'] : SKIP
-      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
-      country = hash['country'] ||= 'US'
-
-      # 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.
-      Location.new(name: name,
-                   address: address,
-                   address2: address2,
-                   city: city,
-                   state: state,
-                   postal_code: postal_code,
-                   country: country,
-                   additional_properties: additional_properties)
-    end
-
-    # Validates an instance of the object from a given value.
-    # @param [Location | Hash] The value against the validation is performed.
-    def self.validate(value)
-      return true if value.instance_of? self
-
-      return false unless value.instance_of? Hash
-
-      true
-    end
-
-    # Provides a human-readable string representation of the object.
-    def to_s
-      class_name = self.class.name.split('::').last
-      "<#{class_name} name: #{@name}, address: #{@address}, address2: #{@address2}, city:"\
-      " #{@city}, state: #{@state}, postal_code: #{@postal_code}, country: #{@country},"\
-      " 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}, address: #{@address.inspect}, address2:"\
-      " #{@address2.inspect}, city: #{@city.inspect}, state: #{@state.inspect}, postal_code:"\
-      " #{@postal_code.inspect}, country: #{@country.inspect}, additional_properties:"\
-      " #{@additional_properties}>"
-    end
-  end
-end

data/lib/tql_otr_factoring_data_exchange/models/oauth_provider_error.rb

@@ -1,62 +0,0 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-module TqlOtrFactoringDataExchange
-  # OAuth 2 Authorization error codes
-  class OauthProviderError
-    OAUTH_PROVIDER_ERROR = [
-      # The request is missing a required parameter, includes an unsupported
-      # parameter value (other than grant type), repeats a parameter, includes
-      # multiple credentials, utilizes more than one mechanism for
-      # authenticating the client, or is otherwise malformed.
-      INVALID_REQUEST = 'invalid_request'.freeze,
-
-      # Client authentication failed (e.g., unknown client, no client
-      # authentication included, or unsupported authentication method).
-      INVALID_CLIENT = 'invalid_client'.freeze,
-
-      # The provided authorization grant (e.g., authorization code, resource
-      # owner credentials) or refresh token is invalid, expired, revoked, does
-      # not match the redirection URI used in the authorization request, or was
-      # issued to another client.
-      INVALID_GRANT = 'invalid_grant'.freeze,
-
-      # The authenticated client is not authorized to use this authorization
-      # grant type.
-      UNAUTHORIZED_CLIENT = 'unauthorized_client'.freeze,
-
-      # The authorization grant type is not supported by the authorization
-      # server.
-      UNSUPPORTED_GRANT_TYPE = 'unsupported_grant_type'.freeze,
-
-      # The requested scope is invalid, unknown, malformed, or exceeds the scope
-      # granted by the resource owner.
-      INVALID_SCOPE = 'invalid_scope'.freeze
-    ].freeze
-
-    def self.validate(value)
-      return false if value.nil?
-
-      OAUTH_PROVIDER_ERROR.include?(value)
-    end
-
-    def self.from_value(value, default_value = INVALID_REQUEST)
-      return default_value if value.nil?
-
-      str = value.to_s.strip
-
-      case str.downcase
-      when 'invalid_request' then INVALID_REQUEST
-      when 'invalid_client' then INVALID_CLIENT
-      when 'invalid_grant' then INVALID_GRANT
-      when 'unauthorized_client' then UNAUTHORIZED_CLIENT
-      when 'unsupported_grant_type' then UNSUPPORTED_GRANT_TYPE
-      when 'invalid_scope' then INVALID_SCOPE
-      else
-        default_value
-      end
-    end
-  end
-end

data/lib/tql_otr_factoring_data_exchange/models/oauth_scope.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
-  # OAuth 2 scopes supported by the API
-  class OauthScope
-    OAUTH_SCOPE = [
-      # Submit invoices, upload documents, manage assignments
-      FACTORING_WRITE = 'Factoring.Write'.freeze,
-
-      # Query invoice status, search invoices
-      FACTORING_READ = 'Factoring.Read'.freeze
-    ].freeze
-
-    def self.validate(value)
-      return false if value.nil?
-
-      OAUTH_SCOPE.include?(value)
-    end
-
-    def self.from_value(value, default_value = FACTORING_WRITE)
-      return default_value if value.nil?
-
-      str = value.to_s.strip
-
-      case str.downcase
-      when 'factoring_write' then FACTORING_WRITE
-      when 'factoring_read' then FACTORING_READ
-      else
-        default_value
-      end
-    end
-  end
-end

data/lib/tql_otr_factoring_data_exchange/models/oauth_token.rb

@@ -1,96 +0,0 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-module TqlOtrFactoringDataExchange
-  # OAuth 2 Authorization endpoint response
-  class OauthToken < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # Access token
-    # @return [String]
-    attr_accessor :access_token
-
-    # Type of access token
-    # @return [String]
-    attr_accessor :token_type
-
-    # Time in seconds before the access token expires
-    # @return [Integer]
-    attr_accessor :expires_in
-
-    # List of scopes granted
-    # This is a space-delimited list of strings.
-    # @return [String]
-    attr_accessor :scope
-
-    # Time of token expiry as unix timestamp (UTC)
-    # @return [Integer]
-    attr_accessor :expiry
-
-    # Refresh token
-    # Used to get a new access token when it expires.
-    # @return [String]
-    attr_accessor :refresh_token
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['access_token'] = 'access_token'
-      @_hash['token_type'] = 'token_type'
-      @_hash['expires_in'] = 'expires_in'
-      @_hash['scope'] = 'scope'
-      @_hash['expiry'] = 'expiry'
-      @_hash['refresh_token'] = 'refresh_token'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        expires_in
-        scope
-        expiry
-        refresh_token
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(access_token:, token_type:, expires_in: SKIP, scope: SKIP,
-                   expiry: SKIP, refresh_token: SKIP)
-      @access_token = access_token
-      @token_type = token_type
-      @expires_in = expires_in unless expires_in == SKIP
-      @scope = scope unless scope == SKIP
-      @expiry = expiry unless expiry == SKIP
-      @refresh_token = refresh_token unless refresh_token == SKIP
-    end
-
-    # Creates an instance of the object from a hash.
-    def self.from_hash(hash)
-      return nil unless hash
-
-      # Extract variables from the hash.
-      access_token = hash.key?('access_token') ? hash['access_token'] : nil
-      token_type = hash.key?('token_type') ? hash['token_type'] : nil
-      expires_in = hash.key?('expires_in') ? hash['expires_in'] : SKIP
-      scope = hash.key?('scope') ? hash['scope'] : SKIP
-      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
-      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
-
-      # Create object from extracted values.
-      OauthToken.new(access_token: access_token,
-                     token_type: token_type,
-                     expires_in: expires_in,
-                     scope: scope,
-                     expiry: expiry,
-                     refresh_token: refresh_token)
-    end
-  end
-end

data/lib/tql_otr_factoring_data_exchange/models/problem_details.rb

@@ -1,96 +0,0 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-module TqlOtrFactoringDataExchange
-  # [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) Problem Details
-  # response returned for validation errors and other non-success outcomes.
-  class ProblemDetails < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # Short, human-readable summary of the problem type.
-    # @return [String]
-    attr_accessor :title
-
-    # HTTP status code.
-    # @return [Integer]
-    attr_accessor :status
-
-    # Detailed, human-readable explanation specific to this occurrence.
-    # @return [String]
-    attr_accessor :detail
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['title'] = 'title'
-      @_hash['status'] = 'status'
-      @_hash['detail'] = 'detail'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        title
-        status
-        detail
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(title: SKIP, status: SKIP, detail: SKIP,
-                   additional_properties: nil)
-      # Add additional model properties to the instance
-      additional_properties = {} if additional_properties.nil?
-
-      @title = title unless title == SKIP
-      @status = status unless status == SKIP
-      @detail = detail unless detail == 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.
-      title = hash.key?('title') ? hash['title'] : SKIP
-      status = hash.key?('status') ? hash['status'] : SKIP
-      detail = hash.key?('detail') ? hash['detail'] : 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.
-      ProblemDetails.new(title: title,
-                         status: status,
-                         detail: detail,
-                         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} title: #{@title}, status: #{@status}, detail: #{@detail},"\
-      " 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} title: #{@title.inspect}, status: #{@status.inspect}, detail:"\
-      " #{@detail.inspect}, additional_properties: #{@additional_properties}>"
-    end
-  end
-end