fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/customer_to_account_relationship_entity.rb

@@ -0,0 +1,114 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Describes an account related to a customer
+  class CustomerToAccountRelationshipEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account ID of the related account
+    # @return [String]
+    attr_accessor :account_id
+
+    # Links to the account, or to invoke other APIs
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # Type of relationship to the account
+    # @return [AccountHolderRelationship3]
+    attr_accessor :relationship
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'accountId'
+      @_hash['links'] = 'links'
+      @_hash['relationship'] = 'relationship'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        links
+        relationship
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id: SKIP, links: SKIP, relationship: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id unless account_id == SKIP
+      @links = links unless links == SKIP
+      @relationship = relationship unless relationship == 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.
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      # 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')
+      relationship = hash.key?('relationship') ? hash['relationship'] : 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.
+      CustomerToAccountRelationshipEntity.new(account_id: account_id,
+                                              links: links,
+                                              relationship: relationship,
+                                              additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CustomerToAccountRelationshipEntity | 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} account_id: #{@account_id}, links: #{@links}, relationship:"\
+      " #{@relationship}, 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} account_id: #{@account_id.inspect}, links: #{@links.inspect}, relationship:"\
+      " #{@relationship.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/customers_entity.rb

@@ -0,0 +1,104 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # List of customers
+  class CustomersEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Information required to paginate results
+    # @return [PageMetadata3]
+    attr_accessor :page
+
+    # Links used to paginate results
+    # @return [PageMetadataLinks3]
+    attr_accessor :links
+
+    # Array of customers
+    # @return [Array[CustomerEntity]]
+    attr_accessor :customers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['links'] = 'links'
+      @_hash['customers'] = 'customers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+        customers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, links: SKIP, customers: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page unless page == SKIP
+      @links = links unless links == SKIP
+      @customers = customers unless customers == 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 = PageMetadata3.from_hash(hash['page']) if hash['page']
+      links = PageMetadataLinks3.from_hash(hash['links']) if hash['links']
+      # Parameter is an array, so we need to iterate through it
+      customers = nil
+      unless hash['customers'].nil?
+        customers = []
+        hash['customers'].each do |structure|
+          customers << (CustomerEntity.from_hash(structure) if structure)
+        end
+      end
+
+      customers = SKIP unless hash.key?('customers')
+
+      # 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.
+      CustomersEntity.new(page: page,
+                          links: links,
+                          customers: customers,
+                          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}, links: #{@links}, customers: #{@customers},"\
+      " 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}, links: #{@links.inspect}, customers:"\
+      " #{@customers.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/customers_entity1.rb

@@ -0,0 +1,105 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Array of Customers as a JSON response if not encrypted, or as the JSON
+  # payload which is encrypted for an application/jwt response
+  class CustomersEntity1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Information required to paginate results
+    # @return [PageMetadata3]
+    attr_accessor :page
+
+    # Links used to paginate results
+    # @return [PageMetadataLinks3]
+    attr_accessor :links
+
+    # Array of customers
+    # @return [Array[CustomerEntity]]
+    attr_accessor :customers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['links'] = 'links'
+      @_hash['customers'] = 'customers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+        customers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, links: SKIP, customers: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page unless page == SKIP
+      @links = links unless links == SKIP
+      @customers = customers unless customers == 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 = PageMetadata3.from_hash(hash['page']) if hash['page']
+      links = PageMetadataLinks3.from_hash(hash['links']) if hash['links']
+      # Parameter is an array, so we need to iterate through it
+      customers = nil
+      unless hash['customers'].nil?
+        customers = []
+        hash['customers'].each do |structure|
+          customers << (CustomerEntity.from_hash(structure) if structure)
+        end
+      end
+
+      customers = SKIP unless hash.key?('customers')
+
+      # 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.
+      CustomersEntity1.new(page: page,
+                           links: links,
+                           customers: customers,
+                           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}, links: #{@links}, customers: #{@customers},"\
+      " 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}, links: #{@links.inspect}, customers:"\
+      " #{@customers.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/data_cluster.rb

@@ -0,0 +1,108 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Name of permissioned Data Cluster. For Data Cluster definitions refer to the
+  # Consent Components > Data Clusters section of the User Experience Guidelines
+  # document included in the FDX API. `ACCOUNT_PAYMENTS` is deprecated and
+  # replaced with `PAYMENT_SUPPORT` in FDX release V6.1.0, `ACCOUNT_PAYMENTS`
+  # will be removed with V7 release
+  class DataCluster
+    DATA_CLUSTER = [
+      # TODO: Write general description for ACCOUNT_BASIC
+      ACCOUNT_BASIC = 'ACCOUNT_BASIC'.freeze,
+
+      # TODO: Write general description for ACCOUNT_DETAILED
+      ACCOUNT_DETAILED = 'ACCOUNT_DETAILED'.freeze,
+
+      # TODO: Write general description for ACCOUNT_PAYMENTS
+      ACCOUNT_PAYMENTS = 'ACCOUNT_PAYMENTS'.freeze,
+
+      # TODO: Write general description for BALANCES
+      BALANCES = 'BALANCES'.freeze,
+
+      # TODO: Write general description for BILLS
+      BILLS = 'BILLS'.freeze,
+
+      # TODO: Write general description for CUSTOMER_CONTACT
+      CUSTOMER_CONTACT = 'CUSTOMER_CONTACT'.freeze,
+
+      # TODO: Write general description for CUSTOMER_PERSONAL
+      CUSTOMER_PERSONAL = 'CUSTOMER_PERSONAL'.freeze,
+
+      # TODO: Write general description for IMAGES
+      IMAGES = 'IMAGES'.freeze,
+
+      # TODO: Write general description for INVESTMENTS
+      INVESTMENTS = 'INVESTMENTS'.freeze,
+
+      # TODO: Write general description for NOTIFICATIONS
+      NOTIFICATIONS = 'NOTIFICATIONS'.freeze,
+
+      # TODO: Write general description for PAYMENT_SUPPORT
+      PAYMENT_SUPPORT = 'PAYMENT_SUPPORT'.freeze,
+
+      # TODO: Write general description for REWARDS
+      REWARDS = 'REWARDS'.freeze,
+
+      # TODO: Write general description for SCHEDULED_PAYMENTS
+      SCHEDULED_PAYMENTS = 'SCHEDULED_PAYMENTS'.freeze,
+
+      # TODO: Write general description for SOCIAL_SECURITY_NUMBER
+      SOCIAL_SECURITY_NUMBER = 'SOCIAL_SECURITY_NUMBER'.freeze,
+
+      # TODO: Write general description for STATEMENTS
+      STATEMENTS = 'STATEMENTS'.freeze,
+
+      # TODO: Write general description for TAX
+      TAX = 'TAX'.freeze,
+
+      # TODO: Write general description for TERMS_AND_CONDITIONS
+      TERMS_AND_CONDITIONS = 'TERMS_AND_CONDITIONS'.freeze,
+
+      # TODO: Write general description for TRANSACTIONS
+      TRANSACTIONS = 'TRANSACTIONS'.freeze,
+
+      # TODO: Write general description for TRANSFERS
+      TRANSFERS = 'TRANSFERS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACCOUNT_BASIC)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'account_basic' then ACCOUNT_BASIC
+      when 'account_detailed' then ACCOUNT_DETAILED
+      when 'account_payments' then ACCOUNT_PAYMENTS
+      when 'balances' then BALANCES
+      when 'bills' then BILLS
+      when 'customer_contact' then CUSTOMER_CONTACT
+      when 'customer_personal' then CUSTOMER_PERSONAL
+      when 'images' then IMAGES
+      when 'investments' then INVESTMENTS
+      when 'notifications' then NOTIFICATIONS
+      when 'payment_support' then PAYMENT_SUPPORT
+      when 'rewards' then REWARDS
+      when 'scheduled_payments' then SCHEDULED_PAYMENTS
+      when 'social_security_number' then SOCIAL_SECURITY_NUMBER
+      when 'statements' then STATEMENTS
+      when 'tax' then TAX
+      when 'terms_and_conditions' then TERMS_AND_CONDITIONS
+      when 'transactions' then TRANSACTIONS
+      when 'transfers' then TRANSFERS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/data_provider_at_ecosystem_registry.rb

@@ -0,0 +1,214 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Record of Data Provider at Ecosystem Registry. Properties in this structure
+  # use 'snake_case' names to match the properties in [IETF RFC
+  # 7591](https://datatracker.ietf.org/doc/rfc7591/).
+  class DataProviderAtEcosystemRegistry < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of intermediary party
+    # @return [String]
+    attr_accessor :name
+
+    # A short description of the intermediary
+    # @return [String]
+    attr_accessor :description
+
+    # A URL string of a web page providing information about the intermediary
+    # @return [String]
+    attr_accessor :uri
+
+    # A URL string that references a logo for this intermediary
+    # @return [String]
+    attr_accessor :logo_uri
+
+    # Array of strings representing ways to contact people responsible for this
+    # intermediary
+    # @return [Array[String]]
+    attr_accessor :contacts
+
+    # Registry references for this intermediary
+    # @return [Array[RegistryReference]]
+    attr_accessor :registry_references
+
+    # Data Provider Id at ecosystem registry
+    # @return [String]
+    attr_accessor :data_provider_id
+
+    # Space-separated array of provider-supported data clusters
+    # @return [String]
+    attr_accessor :scope
+
+    # The allowable duration types of consent for Data Recipient consumers
+    # @return [Array[ConsentDurationType]]
+    attr_accessor :duration_type
+
+    # The maximum consent duration in days for duration_type TIME_BOUND for the
+    # Data Recipient
+    # @return [Integer]
+    attr_accessor :duration_period
+
+    # The maximum number of days allowed for Data Recipients to obtain in
+    # transaction history
+    # @return [Integer]
+    attr_accessor :lookback_period
+
+    # An array of the intermediaries for this data provider
+    # @return [Array[Intermediary]]
+    attr_accessor :intermediaries
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['uri'] = 'uri'
+      @_hash['logo_uri'] = 'logo_uri'
+      @_hash['contacts'] = 'contacts'
+      @_hash['registry_references'] = 'registry_references'
+      @_hash['data_provider_id'] = 'data_provider_id'
+      @_hash['scope'] = 'scope'
+      @_hash['duration_type'] = 'duration_type'
+      @_hash['duration_period'] = 'duration_period'
+      @_hash['lookback_period'] = 'lookback_period'
+      @_hash['intermediaries'] = 'intermediaries'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        description
+        uri
+        logo_uri
+        contacts
+        registry_references
+        data_provider_id
+        scope
+        duration_type
+        duration_period
+        lookback_period
+        intermediaries
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, description: SKIP, uri: SKIP, logo_uri: SKIP,
+                   contacts: SKIP, registry_references: SKIP,
+                   data_provider_id: SKIP, scope: SKIP, duration_type: SKIP,
+                   duration_period: SKIP, lookback_period: SKIP,
+                   intermediaries: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @description = description unless description == SKIP
+      @uri = uri unless uri == SKIP
+      @logo_uri = logo_uri unless logo_uri == SKIP
+      @contacts = contacts unless contacts == SKIP
+      @registry_references = registry_references unless registry_references == SKIP
+      @data_provider_id = data_provider_id unless data_provider_id == SKIP
+      @scope = scope unless scope == SKIP
+      @duration_type = duration_type unless duration_type == SKIP
+      @duration_period = duration_period unless duration_period == SKIP
+      @lookback_period = lookback_period unless lookback_period == SKIP
+      @intermediaries = intermediaries unless intermediaries == 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
+      description = hash.key?('description') ? hash['description'] : SKIP
+      uri = hash.key?('uri') ? hash['uri'] : SKIP
+      logo_uri = hash.key?('logo_uri') ? hash['logo_uri'] : SKIP
+      contacts = hash.key?('contacts') ? hash['contacts'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      registry_references = nil
+      unless hash['registry_references'].nil?
+        registry_references = []
+        hash['registry_references'].each do |structure|
+          registry_references << (RegistryReference.from_hash(structure) if structure)
+        end
+      end
+
+      registry_references = SKIP unless hash.key?('registry_references')
+      data_provider_id =
+        hash.key?('data_provider_id') ? hash['data_provider_id'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      duration_type = hash.key?('duration_type') ? hash['duration_type'] : SKIP
+      duration_period =
+        hash.key?('duration_period') ? hash['duration_period'] : SKIP
+      lookback_period =
+        hash.key?('lookback_period') ? hash['lookback_period'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      intermediaries = nil
+      unless hash['intermediaries'].nil?
+        intermediaries = []
+        hash['intermediaries'].each do |structure|
+          intermediaries << (Intermediary.from_hash(structure) if structure)
+        end
+      end
+
+      intermediaries = SKIP unless hash.key?('intermediaries')
+
+      # 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.
+      DataProviderAtEcosystemRegistry.new(name: name,
+                                          description: description,
+                                          uri: uri,
+                                          logo_uri: logo_uri,
+                                          contacts: contacts,
+                                          registry_references: registry_references,
+                                          data_provider_id: data_provider_id,
+                                          scope: scope,
+                                          duration_type: duration_type,
+                                          duration_period: duration_period,
+                                          lookback_period: lookback_period,
+                                          intermediaries: intermediaries,
+                                          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} name: #{@name}, description: #{@description}, uri: #{@uri}, logo_uri:"\
+      " #{@logo_uri}, contacts: #{@contacts}, registry_references: #{@registry_references},"\
+      " data_provider_id: #{@data_provider_id}, scope: #{@scope}, duration_type:"\
+      " #{@duration_type}, duration_period: #{@duration_period}, lookback_period:"\
+      " #{@lookback_period}, intermediaries: #{@intermediaries}, 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}, description: #{@description.inspect}, uri:"\
+      " #{@uri.inspect}, logo_uri: #{@logo_uri.inspect}, contacts: #{@contacts.inspect},"\
+      " registry_references: #{@registry_references.inspect}, data_provider_id:"\
+      " #{@data_provider_id.inspect}, scope: #{@scope.inspect}, duration_type:"\
+      " #{@duration_type.inspect}, duration_period: #{@duration_period.inspect}, lookback_period:"\
+      " #{@lookback_period.inspect}, intermediaries: #{@intermediaries.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end