fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/consent_revocation_entity.rb

@@ -0,0 +1,114 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxApi
+  # Details of request to revoke consent grant
+  class ConsentRevocationEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status of the consent = REVOKED
+    # @return [ConsentGrantStatus1]
+    attr_accessor :status
+
+    # The reason for consent revocation
+    # @return [ConsentUpdateReason1]
+    attr_accessor :reason
+
+    # The party initiating consent revocation
+    # @return [PartyType1]
+    attr_accessor :initiator
+
+    # When the consent grant was revoked
+    # @return [DateTime]
+    attr_accessor :updated_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['reason'] = 'reason'
+      @_hash['initiator'] = 'initiator'
+      @_hash['updated_time'] = 'updatedTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        reason
+        initiator
+        updated_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, reason: SKIP, initiator: SKIP,
+                   updated_time: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @status = status unless status == SKIP
+      @reason = reason unless reason == SKIP
+      @initiator = initiator unless initiator == SKIP
+      @updated_time = updated_time unless updated_time == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      initiator = hash.key?('initiator') ? hash['initiator'] : SKIP
+      updated_time = if hash.key?('updatedTime')
+                       (DateTimeHelper.from_rfc3339(hash['updatedTime']) if hash['updatedTime'])
+                     else
+                       SKIP
+                     end
+
+      # 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.
+      ConsentRevocationEntity.new(status: status,
+                                  reason: reason,
+                                  initiator: initiator,
+                                  updated_time: updated_time,
+                                  additional_properties: additional_properties)
+    end
+
+    def to_custom_updated_time
+      DateTimeHelper.to_rfc3339(updated_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, reason: #{@reason}, initiator: #{@initiator},"\
+      " updated_time: #{@updated_time}, 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} status: #{@status.inspect}, reason: #{@reason.inspect}, initiator:"\
+      " #{@initiator.inspect}, updated_time: #{@updated_time.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/consent_revocation_list_entity.rb

@@ -0,0 +1,85 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # List of consent grant revocation requests
+  class ConsentRevocationListEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of revocation requests
+    # @return [Array[ConsentRevocationEntity]]
+    attr_accessor :revocations
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['revocations'] = 'revocations'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        revocations
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(revocations: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @revocations = revocations unless revocations == 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.
+      # Parameter is an array, so we need to iterate through it
+      revocations = nil
+      unless hash['revocations'].nil?
+        revocations = []
+        hash['revocations'].each do |structure|
+          revocations << (ConsentRevocationEntity.from_hash(structure) if structure)
+        end
+      end
+
+      revocations = SKIP unless hash.key?('revocations')
+
+      # 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.
+      ConsentRevocationListEntity.new(revocations: revocations,
+                                      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} revocations: #{@revocations}, 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} revocations: #{@revocations.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/consent_revocation_request_entity.rb

@@ -0,0 +1,85 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Details of request to revoke consent grant
+  class ConsentRevocationRequestEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason for consent revocation
+    # @return [ConsentUpdateReason1]
+    attr_accessor :reason
+
+    # The party initiating revocation
+    # @return [PartyType2]
+    attr_accessor :initiator
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash['initiator'] = 'initiator'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+        initiator
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason: SKIP, initiator: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @reason = reason unless reason == SKIP
+      @initiator = initiator unless initiator == 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.
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      initiator = hash.key?('initiator') ? hash['initiator'] : 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.
+      ConsentRevocationRequestEntity.new(reason: reason,
+                                         initiator: initiator,
+                                         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} reason: #{@reason}, initiator: #{@initiator}, 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} reason: #{@reason.inspect}, initiator: #{@initiator.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/consent_update_reason.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Reason for Updating a Consent Grant
+  class ConsentUpdateReason
+    CONSENT_UPDATE_REASON = [
+      # TODO: Write general description for BUSINESS_RULE
+      BUSINESS_RULE = 'BUSINESS_RULE'.freeze,
+
+      # TODO: Write general description for USER_ACTION
+      USER_ACTION = 'USER_ACTION'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/consent_update_reason1.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The reason for consent revocation
+  class ConsentUpdateReason1
+    CONSENT_UPDATE_REASON1 = [
+      # TODO: Write general description for BUSINESS_RULE
+      BUSINESS_RULE = 'BUSINESS_RULE'.freeze,
+
+      # TODO: Write general description for USER_ACTION
+      USER_ACTION = 'USER_ACTION'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/contact_preferences_type.rb

@@ -0,0 +1,32 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Contact Preferences Type
+  class ContactPreferencesType
+    CONTACT_PREFERENCES_TYPE = [
+      # TODO: Write general description for CELL
+      CELL = 'CELL'.freeze,
+
+      # TODO: Write general description for EMAIL
+      EMAIL = 'EMAIL'.freeze,
+
+      # TODO: Write general description for FAX
+      FAX = 'FAX'.freeze,
+
+      # TODO: Write general description for LETTER
+      LETTER = 'LETTER'.freeze,
+
+      # TODO: Write general description for PHONE
+      PHONE = 'PHONE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/contact_preferences_type2.rb

@@ -0,0 +1,32 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of the contact preference
+  class ContactPreferencesType2
+    CONTACT_PREFERENCES_TYPE2 = [
+      # TODO: Write general description for CELL
+      CELL = 'CELL'.freeze,
+
+      # TODO: Write general description for EMAIL
+      EMAIL = 'EMAIL'.freeze,
+
+      # TODO: Write general description for FAX
+      FAX = 'FAX'.freeze,
+
+      # TODO: Write general description for LETTER
+      LETTER = 'LETTER'.freeze,
+
+      # TODO: Write general description for PHONE
+      PHONE = 'PHONE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/contacts_entity.rb

@@ -0,0 +1,113 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Employer's various contact information
+  class ContactsEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of the contact email addresses
+    # @return [Array[String]]
+    attr_accessor :emails
+
+    # Array of the contact physical addresses
+    # @return [Array[DeliveryAddress]]
+    attr_accessor :addresses
+
+    # Array of the contact telephone numbers
+    # @return [Array[TelephoneNumber]]
+    attr_accessor :telephones
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['emails'] = 'emails'
+      @_hash['addresses'] = 'addresses'
+      @_hash['telephones'] = 'telephones'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        emails
+        addresses
+        telephones
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(emails: SKIP, addresses: SKIP, telephones: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @emails = emails unless emails == SKIP
+      @addresses = addresses unless addresses == SKIP
+      @telephones = telephones unless telephones == 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.
+      emails = hash.key?('emails') ? hash['emails'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      addresses = nil
+      unless hash['addresses'].nil?
+        addresses = []
+        hash['addresses'].each do |structure|
+          addresses << (DeliveryAddress.from_hash(structure) if structure)
+        end
+      end
+
+      addresses = SKIP unless hash.key?('addresses')
+      # Parameter is an array, so we need to iterate through it
+      telephones = nil
+      unless hash['telephones'].nil?
+        telephones = []
+        hash['telephones'].each do |structure|
+          telephones << (TelephoneNumber.from_hash(structure) if structure)
+        end
+      end
+
+      telephones = SKIP unless hash.key?('telephones')
+
+      # 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.
+      ContactsEntity.new(emails: emails,
+                         addresses: addresses,
+                         telephones: telephones,
+                         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} emails: #{@emails}, addresses: #{@addresses}, telephones: #{@telephones},"\
+      " 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} emails: #{@emails.inspect}, addresses: #{@addresses.inspect}, telephones:"\
+      " #{@telephones.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/content_types.rb

@@ -0,0 +1,38 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Types of document formats. (Suggested values)
+  class ContentTypes
+    CONTENT_TYPES = [
+      # TODO: Write general description for ENUM_APPLICATIONJSON
+      ENUM_APPLICATIONJSON = 'application/json'.freeze,
+
+      # TODO: Write general description for ENUM_APPLICATIONPDF
+      ENUM_APPLICATIONPDF = 'application/pdf'.freeze,
+
+      # TODO: Write general description for ENUM_APPLICATIONZIP
+      ENUM_APPLICATIONZIP = 'application/zip'.freeze,
+
+      # TODO: Write general description for ENUM_IMAGEGIF
+      ENUM_IMAGEGIF = 'image/gif'.freeze,
+
+      # TODO: Write general description for ENUM_IMAGEJPEG
+      ENUM_IMAGEJPEG = 'image/jpeg'.freeze,
+
+      # TODO: Write general description for ENUM_IMAGEPNG
+      ENUM_IMAGEPNG = 'image/png'.freeze,
+
+      # TODO: Write general description for ENUM_IMAGETIFF
+      ENUM_IMAGETIFF = 'image/tiff'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end