fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/recurring_payment_for_update_entity.rb

@@ -0,0 +1,133 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Used to create or update a recurring payment. Financial institution is free
+  # to adjust the payment date to accommodate weekends and holidays
+  class RecurringPaymentForUpdateEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Defines how often the payment repeats
+    # @return [RecurringPaymentFrequency2]
+    attr_accessor :frequency
+
+    # Defines how long the payment repeats for
+    # @return [RecurringPaymentDurationEntity2]
+    attr_accessor :duration
+
+    # ID of the account used to source funds for payment
+    # @return [String]
+    attr_accessor :from_account_id
+
+    # ID of the payee to receive funds for the payment
+    # @return [String]
+    attr_accessor :to_payee_id
+
+    # Amount for the payment. Must be positive
+    # @return [Float]
+    attr_accessor :amount
+
+    # User's account identifier with the merchant
+    # @return [String]
+    attr_accessor :merchant_account_id
+
+    # Date that the funds are scheduled to be delivered
+    # @return [Date]
+    attr_accessor :due_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['frequency'] = 'frequency'
+      @_hash['duration'] = 'duration'
+      @_hash['from_account_id'] = 'fromAccountId'
+      @_hash['to_payee_id'] = 'toPayeeId'
+      @_hash['amount'] = 'amount'
+      @_hash['merchant_account_id'] = 'merchantAccountId'
+      @_hash['due_date'] = 'dueDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        duration
+        merchant_account_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(frequency:, from_account_id:, to_payee_id:, amount:,
+                   due_date:, duration: SKIP, merchant_account_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @frequency = frequency
+      @duration = duration unless duration == SKIP
+      @from_account_id = from_account_id
+      @to_payee_id = to_payee_id
+      @amount = amount
+      @merchant_account_id = merchant_account_id unless merchant_account_id == SKIP
+      @due_date = due_date
+      @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.
+      frequency = hash.key?('frequency') ? hash['frequency'] : nil
+      from_account_id = hash.key?('fromAccountId') ? hash['fromAccountId'] : nil
+      to_payee_id = hash.key?('toPayeeId') ? hash['toPayeeId'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      due_date = hash.key?('dueDate') ? hash['dueDate'] : nil
+      duration = RecurringPaymentDurationEntity2.from_hash(hash['duration']) if hash['duration']
+      merchant_account_id =
+        hash.key?('merchantAccountId') ? hash['merchantAccountId'] : 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.
+      RecurringPaymentForUpdateEntity.new(frequency: frequency,
+                                          from_account_id: from_account_id,
+                                          to_payee_id: to_payee_id,
+                                          amount: amount,
+                                          due_date: due_date,
+                                          duration: duration,
+                                          merchant_account_id: merchant_account_id,
+                                          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} frequency: #{@frequency}, duration: #{@duration}, from_account_id:"\
+      " #{@from_account_id}, to_payee_id: #{@to_payee_id}, amount: #{@amount},"\
+      " merchant_account_id: #{@merchant_account_id}, due_date: #{@due_date},"\
+      " 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} frequency: #{@frequency.inspect}, duration: #{@duration.inspect},"\
+      " from_account_id: #{@from_account_id.inspect}, to_payee_id: #{@to_payee_id.inspect},"\
+      " amount: #{@amount.inspect}, merchant_account_id: #{@merchant_account_id.inspect},"\
+      " due_date: #{@due_date.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/recurring_payment_for_update_entity1.rb

@@ -0,0 +1,132 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The data of the Recurring Payment to be scheduled
+  class RecurringPaymentForUpdateEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Defines how often the payment repeats
+    # @return [RecurringPaymentFrequency2]
+    attr_accessor :frequency
+
+    # Defines how long the payment repeats for
+    # @return [RecurringPaymentDurationEntity2]
+    attr_accessor :duration
+
+    # ID of the account used to source funds for payment
+    # @return [String]
+    attr_accessor :from_account_id
+
+    # ID of the payee to receive funds for the payment
+    # @return [String]
+    attr_accessor :to_payee_id
+
+    # Amount for the payment. Must be positive
+    # @return [Float]
+    attr_accessor :amount
+
+    # User's account identifier with the merchant
+    # @return [String]
+    attr_accessor :merchant_account_id
+
+    # Date that the funds are scheduled to be delivered
+    # @return [Date]
+    attr_accessor :due_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['frequency'] = 'frequency'
+      @_hash['duration'] = 'duration'
+      @_hash['from_account_id'] = 'fromAccountId'
+      @_hash['to_payee_id'] = 'toPayeeId'
+      @_hash['amount'] = 'amount'
+      @_hash['merchant_account_id'] = 'merchantAccountId'
+      @_hash['due_date'] = 'dueDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        duration
+        merchant_account_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(frequency:, from_account_id:, to_payee_id:, amount:,
+                   due_date:, duration: SKIP, merchant_account_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @frequency = frequency
+      @duration = duration unless duration == SKIP
+      @from_account_id = from_account_id
+      @to_payee_id = to_payee_id
+      @amount = amount
+      @merchant_account_id = merchant_account_id unless merchant_account_id == SKIP
+      @due_date = due_date
+      @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.
+      frequency = hash.key?('frequency') ? hash['frequency'] : nil
+      from_account_id = hash.key?('fromAccountId') ? hash['fromAccountId'] : nil
+      to_payee_id = hash.key?('toPayeeId') ? hash['toPayeeId'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      due_date = hash.key?('dueDate') ? hash['dueDate'] : nil
+      duration = RecurringPaymentDurationEntity2.from_hash(hash['duration']) if hash['duration']
+      merchant_account_id =
+        hash.key?('merchantAccountId') ? hash['merchantAccountId'] : 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.
+      RecurringPaymentForUpdateEntity1.new(frequency: frequency,
+                                           from_account_id: from_account_id,
+                                           to_payee_id: to_payee_id,
+                                           amount: amount,
+                                           due_date: due_date,
+                                           duration: duration,
+                                           merchant_account_id: merchant_account_id,
+                                           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} frequency: #{@frequency}, duration: #{@duration}, from_account_id:"\
+      " #{@from_account_id}, to_payee_id: #{@to_payee_id}, amount: #{@amount},"\
+      " merchant_account_id: #{@merchant_account_id}, due_date: #{@due_date},"\
+      " 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} frequency: #{@frequency.inspect}, duration: #{@duration.inspect},"\
+      " from_account_id: #{@from_account_id.inspect}, to_payee_id: #{@to_payee_id.inspect},"\
+      " amount: #{@amount.inspect}, merchant_account_id: #{@merchant_account_id.inspect},"\
+      " due_date: #{@due_date.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/recurring_payment_for_update_entity2.rb

@@ -0,0 +1,132 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The data of the Recurring Payment to be updated
+  class RecurringPaymentForUpdateEntity2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Defines how often the payment repeats
+    # @return [RecurringPaymentFrequency2]
+    attr_accessor :frequency
+
+    # Defines how long the payment repeats for
+    # @return [RecurringPaymentDurationEntity2]
+    attr_accessor :duration
+
+    # ID of the account used to source funds for payment
+    # @return [String]
+    attr_accessor :from_account_id
+
+    # ID of the payee to receive funds for the payment
+    # @return [String]
+    attr_accessor :to_payee_id
+
+    # Amount for the payment. Must be positive
+    # @return [Float]
+    attr_accessor :amount
+
+    # User's account identifier with the merchant
+    # @return [String]
+    attr_accessor :merchant_account_id
+
+    # Date that the funds are scheduled to be delivered
+    # @return [Date]
+    attr_accessor :due_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['frequency'] = 'frequency'
+      @_hash['duration'] = 'duration'
+      @_hash['from_account_id'] = 'fromAccountId'
+      @_hash['to_payee_id'] = 'toPayeeId'
+      @_hash['amount'] = 'amount'
+      @_hash['merchant_account_id'] = 'merchantAccountId'
+      @_hash['due_date'] = 'dueDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        duration
+        merchant_account_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(frequency:, from_account_id:, to_payee_id:, amount:,
+                   due_date:, duration: SKIP, merchant_account_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @frequency = frequency
+      @duration = duration unless duration == SKIP
+      @from_account_id = from_account_id
+      @to_payee_id = to_payee_id
+      @amount = amount
+      @merchant_account_id = merchant_account_id unless merchant_account_id == SKIP
+      @due_date = due_date
+      @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.
+      frequency = hash.key?('frequency') ? hash['frequency'] : nil
+      from_account_id = hash.key?('fromAccountId') ? hash['fromAccountId'] : nil
+      to_payee_id = hash.key?('toPayeeId') ? hash['toPayeeId'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      due_date = hash.key?('dueDate') ? hash['dueDate'] : nil
+      duration = RecurringPaymentDurationEntity2.from_hash(hash['duration']) if hash['duration']
+      merchant_account_id =
+        hash.key?('merchantAccountId') ? hash['merchantAccountId'] : 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.
+      RecurringPaymentForUpdateEntity2.new(frequency: frequency,
+                                           from_account_id: from_account_id,
+                                           to_payee_id: to_payee_id,
+                                           amount: amount,
+                                           due_date: due_date,
+                                           duration: duration,
+                                           merchant_account_id: merchant_account_id,
+                                           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} frequency: #{@frequency}, duration: #{@duration}, from_account_id:"\
+      " #{@from_account_id}, to_payee_id: #{@to_payee_id}, amount: #{@amount},"\
+      " merchant_account_id: #{@merchant_account_id}, due_date: #{@due_date},"\
+      " 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} frequency: #{@frequency.inspect}, duration: #{@duration.inspect},"\
+      " from_account_id: #{@from_account_id.inspect}, to_payee_id: #{@to_payee_id.inspect},"\
+      " amount: #{@amount.inspect}, merchant_account_id: #{@merchant_account_id.inspect},"\
+      " due_date: #{@due_date.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/recurring_payment_frequency.rb

@@ -0,0 +1,46 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Defines how often a payment is made relative to the starting day.   *
+  # `BIWEEKLY`: Every 14 days   * `TWICEMONTHLY`: Every 15 days   * `WEEKLY`:
+  # Every 7 days
+  class RecurringPaymentFrequency
+    RECURRING_PAYMENT_FREQUENCY = [
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BIWEEKLY'.freeze,
+
+      # TODO: Write general description for TWICEMONTHLY
+      TWICEMONTHLY = 'TWICEMONTHLY'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for FOURWEEKS
+      FOURWEEKS = 'FOURWEEKS'.freeze,
+
+      # TODO: Write general description for BIMONTHLY
+      BIMONTHLY = 'BIMONTHLY'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'QUARTERLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'SEMIANNUALLY'.freeze,
+
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/recurring_payment_frequency2.rb

@@ -0,0 +1,44 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Defines how often the payment repeats
+  class RecurringPaymentFrequency2
+    RECURRING_PAYMENT_FREQUENCY2 = [
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BIWEEKLY'.freeze,
+
+      # TODO: Write general description for TWICEMONTHLY
+      TWICEMONTHLY = 'TWICEMONTHLY'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for FOURWEEKS
+      FOURWEEKS = 'FOURWEEKS'.freeze,
+
+      # TODO: Write general description for BIMONTHLY
+      BIMONTHLY = 'BIMONTHLY'.freeze,
+
+      # TODO: Write general description for QUARTERLY
+      QUARTERLY = 'QUARTERLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'SEMIANNUALLY'.freeze,
+
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/recurring_payment_status.rb

@@ -0,0 +1,33 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Defines the recurring payment lifecycle   * `CANCELLED`: Recurring Payment
+  # was cancelled by the user   * `FAILED`: Recurring Payment failed. For
+  # example: fraud, invalid payee, source account was closed etc.   *
+  # `PROCESSED`: The scheduled duration of the recurrence has completed   *
+  # `SCHEDULED`: Recurring Payment has been scheduled
+  class RecurringPaymentStatus
+    RECURRING_PAYMENT_STATUS = [
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'CANCELLED'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze,
+
+      # TODO: Write general description for PROCESSED
+      PROCESSED = 'PROCESSED'.freeze,
+
+      # TODO: Write general description for SCHEDULED
+      SCHEDULED = 'SCHEDULED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/recurring_payment_status2.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Defines the status of the recurring payment
+  class RecurringPaymentStatus2
+    RECURRING_PAYMENT_STATUS2 = [
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'CANCELLED'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze,
+
+      # TODO: Write general description for PROCESSED
+      PROCESSED = 'PROCESSED'.freeze,
+
+      # TODO: Write general description for SCHEDULED
+      SCHEDULED = 'SCHEDULED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/recurring_payments_entity.rb

@@ -0,0 +1,113 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # A list of recurring payments
+  class RecurringPaymentsEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Offset IDs for navigating result sets
+    # @return [PageMetadata]
+    attr_accessor :page
+
+    # Update IDs for retrieving updates since query
+    # @return [UpdatesMetadataEntity2]
+    attr_accessor :updates
+
+    # Resource URLs for navigating result sets
+    # @return [SynchronizableArrayLinksEntity2]
+    attr_accessor :links
+
+    # Recurring payments retrieved by the operation
+    # @return [Array[RecurringPaymentEntity]]
+    attr_accessor :recurring_payments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['updates'] = 'updates'
+      @_hash['links'] = 'links'
+      @_hash['recurring_payments'] = 'recurringPayments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        updates
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(recurring_payments:, page: SKIP, updates: SKIP, links: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page unless page == SKIP
+      @updates = updates unless updates == SKIP
+      @links = links unless links == SKIP
+      @recurring_payments = recurring_payments
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      recurring_payments = nil
+      unless hash['recurringPayments'].nil?
+        recurring_payments = []
+        hash['recurringPayments'].each do |structure|
+          recurring_payments << (RecurringPaymentEntity.from_hash(structure) if structure)
+        end
+      end
+
+      recurring_payments = nil unless hash.key?('recurringPayments')
+      page = PageMetadata.from_hash(hash['page']) if hash['page']
+      updates = UpdatesMetadataEntity2.from_hash(hash['updates']) if hash['updates']
+      links = SynchronizableArrayLinksEntity2.from_hash(hash['links']) if hash['links']
+
+      # 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.
+      RecurringPaymentsEntity.new(recurring_payments: recurring_payments,
+                                  page: page,
+                                  updates: updates,
+                                  links: links,
+                                  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}, updates: #{@updates}, links: #{@links}, recurring_payments:"\
+      " #{@recurring_payments}, 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}, updates: #{@updates.inspect}, links:"\
+      " #{@links.inspect}, recurring_payments: #{@recurring_payments.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/registry.rb

@@ -0,0 +1,30 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The registry containing the party's registration with name and id: FDX,
+  # GLEIF, ICANN, PRIVATE
+  class Registry
+    REGISTRY = [
+      # TODO: Write general description for FDX
+      FDX = 'FDX'.freeze,
+
+      # TODO: Write general description for GLEIF
+      GLEIF = 'GLEIF'.freeze,
+
+      # TODO: Write general description for ICANN
+      ICANN = 'ICANN'.freeze,
+
+      # TODO: Write general description for PRIVATE
+      PRIVATE = 'PRIVATE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end