fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/payment_entity.rb

@@ -0,0 +1,262 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxApi
+  # Represents a payment
+  class PaymentEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # Uniquely identifies a payment. Used within the API to reference a payment
+    # @return [String]
+    attr_accessor :payment_id
+
+    # The recurring payment that spawned this payment. Null if payment is not
+    # associated with a recurring payment
+    # @return [String]
+    attr_accessor :recurring_payment_id
+
+    # When the payment was scheduled
+    # @return [DateTime]
+    attr_accessor :scheduled_timestamp
+
+    # When the payment was processed
+    # @return [DateTime]
+    attr_accessor :processed_timestamp
+
+    # When the payment failed. Includes when the payment was determined to lack
+    # sufficient funds
+    # @return [DateTime]
+    attr_accessor :failed_timestamp
+
+    # When the payment was cancelled
+    # @return [DateTime]
+    attr_accessor :cancelled_timestamp
+
+    # When the payment execution started
+    # @return [DateTime]
+    attr_accessor :started_processing_timestamp
+
+    # Defines the status of the payment
+    # @return [PaymentStatus3]
+    attr_accessor :status
+
+    # Links to related payment entities
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['from_account_id'] = 'fromAccountId'
+      @_hash['to_payee_id'] = 'toPayeeId'
+      @_hash['amount'] = 'amount'
+      @_hash['merchant_account_id'] = 'merchantAccountId'
+      @_hash['due_date'] = 'dueDate'
+      @_hash['payment_id'] = 'paymentId'
+      @_hash['recurring_payment_id'] = 'recurringPaymentId'
+      @_hash['scheduled_timestamp'] = 'scheduledTimestamp'
+      @_hash['processed_timestamp'] = 'processedTimestamp'
+      @_hash['failed_timestamp'] = 'failedTimestamp'
+      @_hash['cancelled_timestamp'] = 'cancelledTimestamp'
+      @_hash['started_processing_timestamp'] = 'startedProcessingTimestamp'
+      @_hash['status'] = 'status'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_account_id
+        recurring_payment_id
+        scheduled_timestamp
+        processed_timestamp
+        failed_timestamp
+        cancelled_timestamp
+        started_processing_timestamp
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(from_account_id:, to_payee_id:, amount:, due_date:,
+                   payment_id:, status:, merchant_account_id: SKIP,
+                   recurring_payment_id: SKIP, scheduled_timestamp: SKIP,
+                   processed_timestamp: SKIP, failed_timestamp: SKIP,
+                   cancelled_timestamp: SKIP,
+                   started_processing_timestamp: SKIP, links: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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
+      @payment_id = payment_id
+      @recurring_payment_id = recurring_payment_id unless recurring_payment_id == SKIP
+      @scheduled_timestamp = scheduled_timestamp unless scheduled_timestamp == SKIP
+      @processed_timestamp = processed_timestamp unless processed_timestamp == SKIP
+      @failed_timestamp = failed_timestamp unless failed_timestamp == SKIP
+      @cancelled_timestamp = cancelled_timestamp unless cancelled_timestamp == SKIP
+      unless started_processing_timestamp == SKIP
+        @started_processing_timestamp =
+          started_processing_timestamp
+      end
+      @status = status
+      @links = links unless links == 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.
+      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
+      payment_id = hash.key?('paymentId') ? hash['paymentId'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      merchant_account_id =
+        hash.key?('merchantAccountId') ? hash['merchantAccountId'] : SKIP
+      recurring_payment_id =
+        hash.key?('recurringPaymentId') ? hash['recurringPaymentId'] : SKIP
+      scheduled_timestamp = if hash.key?('scheduledTimestamp')
+                              (DateTimeHelper.from_rfc3339(hash['scheduledTimestamp']) if hash['scheduledTimestamp'])
+                            else
+                              SKIP
+                            end
+      processed_timestamp = if hash.key?('processedTimestamp')
+                              (DateTimeHelper.from_rfc3339(hash['processedTimestamp']) if hash['processedTimestamp'])
+                            else
+                              SKIP
+                            end
+      failed_timestamp = if hash.key?('failedTimestamp')
+                           (DateTimeHelper.from_rfc3339(hash['failedTimestamp']) if hash['failedTimestamp'])
+                         else
+                           SKIP
+                         end
+      cancelled_timestamp = if hash.key?('cancelledTimestamp')
+                              (DateTimeHelper.from_rfc3339(hash['cancelledTimestamp']) if hash['cancelledTimestamp'])
+                            else
+                              SKIP
+                            end
+      started_processing_timestamp = if hash.key?('startedProcessingTimestamp')
+                                       (DateTimeHelper.from_rfc3339(hash['startedProcessingTimestamp']) if hash['startedProcessingTimestamp'])
+                                     else
+                                       SKIP
+                                     end
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (HateoasLink.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('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.
+      PaymentEntity.new(from_account_id: from_account_id,
+                        to_payee_id: to_payee_id,
+                        amount: amount,
+                        due_date: due_date,
+                        payment_id: payment_id,
+                        status: status,
+                        merchant_account_id: merchant_account_id,
+                        recurring_payment_id: recurring_payment_id,
+                        scheduled_timestamp: scheduled_timestamp,
+                        processed_timestamp: processed_timestamp,
+                        failed_timestamp: failed_timestamp,
+                        cancelled_timestamp: cancelled_timestamp,
+                        started_processing_timestamp: started_processing_timestamp,
+                        links: links,
+                        additional_properties: additional_properties)
+    end
+
+    def to_custom_scheduled_timestamp
+      DateTimeHelper.to_rfc3339(scheduled_timestamp)
+    end
+
+    def to_custom_processed_timestamp
+      DateTimeHelper.to_rfc3339(processed_timestamp)
+    end
+
+    def to_custom_failed_timestamp
+      DateTimeHelper.to_rfc3339(failed_timestamp)
+    end
+
+    def to_custom_cancelled_timestamp
+      DateTimeHelper.to_rfc3339(cancelled_timestamp)
+    end
+
+    def to_custom_started_processing_timestamp
+      DateTimeHelper.to_rfc3339(started_processing_timestamp)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} from_account_id: #{@from_account_id}, to_payee_id: #{@to_payee_id}, amount:"\
+      " #{@amount}, merchant_account_id: #{@merchant_account_id}, due_date: #{@due_date},"\
+      " payment_id: #{@payment_id}, recurring_payment_id: #{@recurring_payment_id},"\
+      " scheduled_timestamp: #{@scheduled_timestamp}, processed_timestamp:"\
+      " #{@processed_timestamp}, failed_timestamp: #{@failed_timestamp}, cancelled_timestamp:"\
+      " #{@cancelled_timestamp}, started_processing_timestamp: #{@started_processing_timestamp},"\
+      " status: #{@status}, links: #{@links}, 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} 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}, payment_id:"\
+      " #{@payment_id.inspect}, recurring_payment_id: #{@recurring_payment_id.inspect},"\
+      " scheduled_timestamp: #{@scheduled_timestamp.inspect}, processed_timestamp:"\
+      " #{@processed_timestamp.inspect}, failed_timestamp: #{@failed_timestamp.inspect},"\
+      " cancelled_timestamp: #{@cancelled_timestamp.inspect}, started_processing_timestamp:"\
+      " #{@started_processing_timestamp.inspect}, status: #{@status.inspect}, links:"\
+      " #{@links.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/payment_for_update_entity.rb

@@ -0,0 +1,113 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Payment entity used for creation and update of a payment
+  class PaymentForUpdateEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['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[
+        merchant_account_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(from_account_id:, to_payee_id:, amount:, due_date:,
+                   merchant_account_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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.
+      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
+      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.
+      PaymentForUpdateEntity.new(from_account_id: from_account_id,
+                                 to_payee_id: to_payee_id,
+                                 amount: amount,
+                                 due_date: due_date,
+                                 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} 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} 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/payment_for_update_entity1.rb

@@ -0,0 +1,113 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The data of the Payment to be scheduled
+  class PaymentForUpdateEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['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[
+        merchant_account_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(from_account_id:, to_payee_id:, amount:, due_date:,
+                   merchant_account_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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.
+      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
+      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.
+      PaymentForUpdateEntity1.new(from_account_id: from_account_id,
+                                  to_payee_id: to_payee_id,
+                                  amount: amount,
+                                  due_date: due_date,
+                                  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} 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} 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/payment_for_update_entity2.rb

@@ -0,0 +1,113 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The data of the Payment to be updated
+  class PaymentForUpdateEntity2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['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[
+        merchant_account_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(from_account_id:, to_payee_id:, amount:, due_date:,
+                   merchant_account_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @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.
+      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
+      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.
+      PaymentForUpdateEntity2.new(from_account_id: from_account_id,
+                                  to_payee_id: to_payee_id,
+                                  amount: amount,
+                                  due_date: due_date,
+                                  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} 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} 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/payment_frequency.rb

@@ -0,0 +1,38 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The frequency of payments
+  class PaymentFrequency
+    PAYMENT_FREQUENCY = [
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BIWEEKLY'.freeze,
+
+      # TODO: Write general description for DAILY
+      DAILY = 'DAILY'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'SEMIANNUALLY'.freeze,
+
+      # TODO: Write general description for SEMIMONTHLY
+      SEMIMONTHLY = 'SEMIMONTHLY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/payment_frequency1.rb

@@ -0,0 +1,38 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # DAILY, WEEKLY, BIWEEKLY, SEMIMONTHLY, MONTHLY, SEMIANNUALLY, ANNUALLY
+  class PaymentFrequency1
+    PAYMENT_FREQUENCY1 = [
+      # TODO: Write general description for ANNUALLY
+      ANNUALLY = 'ANNUALLY'.freeze,
+
+      # TODO: Write general description for BIWEEKLY
+      BIWEEKLY = 'BIWEEKLY'.freeze,
+
+      # TODO: Write general description for DAILY
+      DAILY = 'DAILY'.freeze,
+
+      # TODO: Write general description for MONTHLY
+      MONTHLY = 'MONTHLY'.freeze,
+
+      # TODO: Write general description for SEMIANNUALLY
+      SEMIANNUALLY = 'SEMIANNUALLY'.freeze,
+
+      # TODO: Write general description for SEMIMONTHLY
+      SEMIMONTHLY = 'SEMIMONTHLY'.freeze,
+
+      # TODO: Write general description for WEEKLY
+      WEEKLY = 'WEEKLY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end