fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/recipient_provider.rb

@@ -0,0 +1,293 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Record of Recipient at the Provider. Properties in this structure use
+  # 'snake_case' names to match the properties in [IETF RFC
+  # 7591](https://datatracker.ietf.org/doc/rfc7591/)
+  class RecipientProvider < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Data Recipient or Data Recipient Application name displayed by Data
+    # Provider during the consent Flow as well as in the Consent Dashboard
+    # @return [String]
+    attr_accessor :client_name
+
+    # A short description of the Data Recipient application
+    # @return [String]
+    attr_accessor :description
+
+    # An array of eligible Redirect URI targets
+    # @return [Array[String]]
+    attr_accessor :redirect_uris
+
+    # Data Recipient Logo URL location
+    # @return [String]
+    attr_accessor :logo_uri
+
+    # The URI which provides additional information about the Data Recipient
+    # @return [String]
+    attr_accessor :client_uri
+
+    # Array of strings representing ways to contact individuals responsible for
+    # the Data Recipient application
+    # @return [Array[String]]
+    attr_accessor :contacts
+
+    # String form field with a list of data clusters
+    # @return [String]
+    attr_accessor :scope
+
+    # The duration of consent for the 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, effective from the date of consent
+    # @return [Integer]
+    attr_accessor :duration_period
+
+    # The maximum number of days allowed for Data Recipient to obtain in
+    # transaction history, effective from the current date
+    # @return [Integer]
+    attr_accessor :lookback_period
+
+    # An array of external registries containing registered entity name,
+    # registered entity id and registry fields for the registries where the data
+    # recipient is registered
+    # @return [Array[RegistryReference]]
+    attr_accessor :registry_references
+
+    # An array of the intermediaries for this data recipient
+    # @return [Array[Intermediary]]
+    attr_accessor :intermediaries
+
+    # OAuth 2.0 client identifier.  Unique ID representing Data Recipient and
+    # Identity Chain combination
+    # @return [String]
+    attr_accessor :client_id
+
+    # OAuth 2.0 client secret string
+    # @return [String]
+    attr_accessor :client_secret
+
+    # Array of OAuth 2.0 grants made available to the Data Recipient
+    # @return [Array[String]]
+    attr_accessor :grant_types
+
+    # Requested Authentication method for Authorization Server
+    # @return [String]
+    attr_accessor :token_endpoint_auth_method
+
+    # Fully qualified URI for subsequent DCR calls (GET, PUT, DELETE) for
+    # managing the Data Recipient registration
+    # @return [String]
+    attr_accessor :registration_client_uri
+
+    # Status of FDX OAuth 2.0 extension
+    # @return [String]
+    attr_accessor :status
+
+    # String containing a unique DCR access token to be used in subsequent
+    # operations to manage the Data Recipient
+    # @return [String]
+    attr_accessor :registration_access_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_name'] = 'client_name'
+      @_hash['description'] = 'description'
+      @_hash['redirect_uris'] = 'redirect_uris'
+      @_hash['logo_uri'] = 'logo_uri'
+      @_hash['client_uri'] = 'client_uri'
+      @_hash['contacts'] = 'contacts'
+      @_hash['scope'] = 'scope'
+      @_hash['duration_type'] = 'duration_type'
+      @_hash['duration_period'] = 'duration_period'
+      @_hash['lookback_period'] = 'lookback_period'
+      @_hash['registry_references'] = 'registry_references'
+      @_hash['intermediaries'] = 'intermediaries'
+      @_hash['client_id'] = 'client_id'
+      @_hash['client_secret'] = 'client_secret'
+      @_hash['grant_types'] = 'grant_types'
+      @_hash['token_endpoint_auth_method'] = 'token_endpoint_auth_method'
+      @_hash['registration_client_uri'] = 'registration_client_uri'
+      @_hash['status'] = 'status'
+      @_hash['registration_access_token'] = 'registration_access_token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        logo_uri
+        client_uri
+        contacts
+        scope
+        duration_type
+        duration_period
+        lookback_period
+        registry_references
+        intermediaries
+        client_secret
+        registration_client_uri
+        registration_access_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_name:, redirect_uris:, client_id:, grant_types:,
+                   token_endpoint_auth_method:, status:, description: SKIP,
+                   logo_uri: SKIP, client_uri: SKIP, contacts: SKIP,
+                   scope: SKIP, duration_type: SKIP, duration_period: SKIP,
+                   lookback_period: SKIP, registry_references: SKIP,
+                   intermediaries: SKIP, client_secret: SKIP,
+                   registration_client_uri: SKIP,
+                   registration_access_token: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @client_name = client_name
+      @description = description unless description == SKIP
+      @redirect_uris = redirect_uris
+      @logo_uri = logo_uri unless logo_uri == SKIP
+      @client_uri = client_uri unless client_uri == SKIP
+      @contacts = contacts unless contacts == 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
+      @registry_references = registry_references unless registry_references == SKIP
+      @intermediaries = intermediaries unless intermediaries == SKIP
+      @client_id = client_id
+      @client_secret = client_secret unless client_secret == SKIP
+      @grant_types = grant_types
+      @token_endpoint_auth_method = token_endpoint_auth_method
+      @registration_client_uri = registration_client_uri unless registration_client_uri == SKIP
+      @status = status
+      unless registration_access_token == SKIP
+        @registration_access_token =
+          registration_access_token
+      end
+      @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.
+      client_name = hash.key?('client_name') ? hash['client_name'] : nil
+      redirect_uris = hash.key?('redirect_uris') ? hash['redirect_uris'] : nil
+      client_id = hash.key?('client_id') ? hash['client_id'] : nil
+      grant_types = hash.key?('grant_types') ? hash['grant_types'] : nil
+      token_endpoint_auth_method =
+        hash.key?('token_endpoint_auth_method') ? hash['token_endpoint_auth_method'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      logo_uri = hash.key?('logo_uri') ? hash['logo_uri'] : SKIP
+      client_uri = hash.key?('client_uri') ? hash['client_uri'] : SKIP
+      contacts = hash.key?('contacts') ? hash['contacts'] : 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
+      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')
+      # 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')
+      client_secret = hash.key?('client_secret') ? hash['client_secret'] : SKIP
+      registration_client_uri =
+        hash.key?('registration_client_uri') ? hash['registration_client_uri'] : SKIP
+      registration_access_token =
+        hash.key?('registration_access_token') ? hash['registration_access_token'] : 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.
+      RecipientProvider.new(client_name: client_name,
+                            redirect_uris: redirect_uris,
+                            client_id: client_id,
+                            grant_types: grant_types,
+                            token_endpoint_auth_method: token_endpoint_auth_method,
+                            status: status,
+                            description: description,
+                            logo_uri: logo_uri,
+                            client_uri: client_uri,
+                            contacts: contacts,
+                            scope: scope,
+                            duration_type: duration_type,
+                            duration_period: duration_period,
+                            lookback_period: lookback_period,
+                            registry_references: registry_references,
+                            intermediaries: intermediaries,
+                            client_secret: client_secret,
+                            registration_client_uri: registration_client_uri,
+                            registration_access_token: registration_access_token,
+                            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} client_name: #{@client_name}, description: #{@description}, redirect_uris:"\
+      " #{@redirect_uris}, logo_uri: #{@logo_uri}, client_uri: #{@client_uri}, contacts:"\
+      " #{@contacts}, scope: #{@scope}, duration_type: #{@duration_type}, duration_period:"\
+      " #{@duration_period}, lookback_period: #{@lookback_period}, registry_references:"\
+      " #{@registry_references}, intermediaries: #{@intermediaries}, client_id: #{@client_id},"\
+      " client_secret: #{@client_secret}, grant_types: #{@grant_types},"\
+      " token_endpoint_auth_method: #{@token_endpoint_auth_method}, registration_client_uri:"\
+      " #{@registration_client_uri}, status: #{@status}, registration_access_token:"\
+      " #{@registration_access_token}, 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} client_name: #{@client_name.inspect}, description: #{@description.inspect},"\
+      " redirect_uris: #{@redirect_uris.inspect}, logo_uri: #{@logo_uri.inspect}, client_uri:"\
+      " #{@client_uri.inspect}, contacts: #{@contacts.inspect}, scope: #{@scope.inspect},"\
+      " duration_type: #{@duration_type.inspect}, duration_period: #{@duration_period.inspect},"\
+      " lookback_period: #{@lookback_period.inspect}, registry_references:"\
+      " #{@registry_references.inspect}, intermediaries: #{@intermediaries.inspect}, client_id:"\
+      " #{@client_id.inspect}, client_secret: #{@client_secret.inspect}, grant_types:"\
+      " #{@grant_types.inspect}, token_endpoint_auth_method:"\
+      " #{@token_endpoint_auth_method.inspect}, registration_client_uri:"\
+      " #{@registration_client_uri.inspect}, status: #{@status.inspect},"\
+      " registration_access_token: #{@registration_access_token.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/recipient_record_at_ecosystem_registry.rb

@@ -0,0 +1,223 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Record of Recipient at the 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 RecipientRecordAtEcosystemRegistry < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Data Recipient or Data Recipient Application name displayed by Data
+    # Provider during the consent Flow as well as in the Consent Dashboard
+    # @return [String]
+    attr_accessor :client_name
+
+    # A short description of the Data Recipient application
+    # @return [String]
+    attr_accessor :description
+
+    # An array of eligible Redirect URI targets
+    # @return [Array[String]]
+    attr_accessor :redirect_uris
+
+    # Data Recipient Logo URL location
+    # @return [String]
+    attr_accessor :logo_uri
+
+    # The URI which provides additional information about the Data Recipient
+    # @return [String]
+    attr_accessor :client_uri
+
+    # Array of strings representing ways to contact individuals responsible for
+    # the Data Recipient application
+    # @return [Array[String]]
+    attr_accessor :contacts
+
+    # String form field with a list of data clusters
+    # @return [String]
+    attr_accessor :scope
+
+    # The duration of consent for the 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, effective from the date of consent
+    # @return [Integer]
+    attr_accessor :duration_period
+
+    # The maximum number of days allowed for Data Recipient to obtain in
+    # transaction history, effective from the current date
+    # @return [Integer]
+    attr_accessor :lookback_period
+
+    # An array of external registries containing registered entity name,
+    # registered entity id and registry fields for the registries where the data
+    # recipient is registered
+    # @return [Array[RegistryReference]]
+    attr_accessor :registry_references
+
+    # An array of the intermediaries for this data recipient
+    # @return [Array[Intermediary]]
+    attr_accessor :intermediaries
+
+    # Recipient Id at ecosystem registry
+    # @return [String]
+    attr_accessor :recipient_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_name'] = 'client_name'
+      @_hash['description'] = 'description'
+      @_hash['redirect_uris'] = 'redirect_uris'
+      @_hash['logo_uri'] = 'logo_uri'
+      @_hash['client_uri'] = 'client_uri'
+      @_hash['contacts'] = 'contacts'
+      @_hash['scope'] = 'scope'
+      @_hash['duration_type'] = 'duration_type'
+      @_hash['duration_period'] = 'duration_period'
+      @_hash['lookback_period'] = 'lookback_period'
+      @_hash['registry_references'] = 'registry_references'
+      @_hash['intermediaries'] = 'intermediaries'
+      @_hash['recipient_id'] = 'recipient_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        logo_uri
+        client_uri
+        contacts
+        scope
+        duration_type
+        duration_period
+        lookback_period
+        registry_references
+        intermediaries
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_name:, redirect_uris:, recipient_id:,
+                   description: SKIP, logo_uri: SKIP, client_uri: SKIP,
+                   contacts: SKIP, scope: SKIP, duration_type: SKIP,
+                   duration_period: SKIP, lookback_period: SKIP,
+                   registry_references: SKIP, intermediaries: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @client_name = client_name
+      @description = description unless description == SKIP
+      @redirect_uris = redirect_uris
+      @logo_uri = logo_uri unless logo_uri == SKIP
+      @client_uri = client_uri unless client_uri == SKIP
+      @contacts = contacts unless contacts == 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
+      @registry_references = registry_references unless registry_references == SKIP
+      @intermediaries = intermediaries unless intermediaries == SKIP
+      @recipient_id = recipient_id
+      @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.
+      client_name = hash.key?('client_name') ? hash['client_name'] : nil
+      redirect_uris = hash.key?('redirect_uris') ? hash['redirect_uris'] : nil
+      recipient_id = hash.key?('recipient_id') ? hash['recipient_id'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      logo_uri = hash.key?('logo_uri') ? hash['logo_uri'] : SKIP
+      client_uri = hash.key?('client_uri') ? hash['client_uri'] : SKIP
+      contacts = hash.key?('contacts') ? hash['contacts'] : 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
+      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')
+      # 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.
+      RecipientRecordAtEcosystemRegistry.new(client_name: client_name,
+                                             redirect_uris: redirect_uris,
+                                             recipient_id: recipient_id,
+                                             description: description,
+                                             logo_uri: logo_uri,
+                                             client_uri: client_uri,
+                                             contacts: contacts,
+                                             scope: scope,
+                                             duration_type: duration_type,
+                                             duration_period: duration_period,
+                                             lookback_period: lookback_period,
+                                             registry_references: registry_references,
+                                             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} client_name: #{@client_name}, description: #{@description}, redirect_uris:"\
+      " #{@redirect_uris}, logo_uri: #{@logo_uri}, client_uri: #{@client_uri}, contacts:"\
+      " #{@contacts}, scope: #{@scope}, duration_type: #{@duration_type}, duration_period:"\
+      " #{@duration_period}, lookback_period: #{@lookback_period}, registry_references:"\
+      " #{@registry_references}, intermediaries: #{@intermediaries}, recipient_id:"\
+      " #{@recipient_id}, 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} client_name: #{@client_name.inspect}, description: #{@description.inspect},"\
+      " redirect_uris: #{@redirect_uris.inspect}, logo_uri: #{@logo_uri.inspect}, client_uri:"\
+      " #{@client_uri.inspect}, contacts: #{@contacts.inspect}, scope: #{@scope.inspect},"\
+      " duration_type: #{@duration_type.inspect}, duration_period: #{@duration_period.inspect},"\
+      " lookback_period: #{@lookback_period.inspect}, registry_references:"\
+      " #{@registry_references.inspect}, intermediaries: #{@intermediaries.inspect}, recipient_id:"\
+      " #{@recipient_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/recipient_records_at_ecosystem_registry.rb

@@ -0,0 +1,105 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Recipient records 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 RecipientRecordsAtEcosystemRegistry < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Offset IDs for navigating result sets
+    # @return [PageMetadata]
+    attr_accessor :page
+
+    # Resource URLs for navigating result sets
+    # @return [PageMetadataLinks]
+    attr_accessor :links
+
+    # Recipients retrieved by the operation
+    # @return [Array[RecipientRecordAtEcosystemRegistry]]
+    attr_accessor :recipients
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['links'] = 'links'
+      @_hash['recipients'] = 'recipients'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(recipients:, page: SKIP, links: 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
+      @recipients = recipients
+      @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
+      recipients = nil
+      unless hash['recipients'].nil?
+        recipients = []
+        hash['recipients'].each do |structure|
+          recipients << (RecipientRecordAtEcosystemRegistry.from_hash(structure) if structure)
+        end
+      end
+
+      recipients = nil unless hash.key?('recipients')
+      page = PageMetadata.from_hash(hash['page']) if hash['page']
+      links = PageMetadataLinks.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.
+      RecipientRecordsAtEcosystemRegistry.new(recipients: recipients,
+                                              page: page,
+                                              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}, links: #{@links}, recipients: #{@recipients},"\
+      " 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}, recipients:"\
+      " #{@recipients.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end