Module: ComplyanceSDK::Models::Purpose

Defined in:
lib/complyance_sdk/models/purpose.rb

Overview

Purpose enumeration

Constant Summary collapse

MAPPING =

Mapping purpose

:mapping
INVOICING =

Invoicing purpose

:invoicing
VALIDATION =

Validation purpose

:validation

Class Method Summary collapse

Class Method Details

.all ⇒ Array<Symbol>

Get all valid purposes

Returns:

  • (Array<Symbol>) —

    All valid purposes



19
20
21
 
# File 'lib/complyance_sdk/models/purpose.rb', line 19

def self.all
  [MAPPING, INVOICING, VALIDATION]
end

.normalize(purpose) ⇒ Symbol?

Convert string to purpose symbol

Parameters:

  • purpose (String, Symbol) —

    The purpose

Returns:

  • (Symbol, nil) —

    The purpose symbol or nil if invalid



36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/complyance_sdk/models/purpose.rb', line 36

def self.normalize(purpose)
  return nil if purpose.nil?
  
  case purpose.to_s.downcase
  when "mapping"
    MAPPING
  when "invoicing"
    INVOICING
  when "validation"
    VALIDATION
  else
    purpose.to_sym if valid?(purpose)
  end
end

.valid?(purpose) ⇒ Boolean

Check if a purpose is valid

Parameters:

  • purpose (Symbol, String) —

    The purpose to check

Returns:

  • (Boolean) —

    True if valid, false otherwise



27
28
29
30
 
# File 'lib/complyance_sdk/models/purpose.rb', line 27

def self.valid?(purpose)
  return false if purpose.nil?
  all.include?(purpose.to_sym)
end