fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/consent_grant_entity.rb

@@ -0,0 +1,232 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxApi
+  # Record of user consent
+  class ConsentGrantEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The persistent identifier of the consent
+    # @return [String]
+    attr_accessor :id
+
+    # The current status of the consent
+    # @return [ConsentGrantStatus3]
+    attr_accessor :status
+
+    # The non-end user parties participating in the Consent Grant
+    # @return [Array[PartyEntity]]
+    attr_accessor :parties
+
+    # When the consent was initially granted
+    # @return [DateTime]
+    attr_accessor :created_time
+
+    # When the consent grant will become expired
+    # @return [DateTime]
+    attr_accessor :expiration_time
+
+    # When the consent grant was updated
+    # @return [DateTime]
+    attr_accessor :updated_time
+
+    # The type of duration of the consent
+    # @return [ConsentDurationType]
+    attr_accessor :duration_type
+
+    # The consent duration in days from day of original grant
+    # @return [Integer]
+    attr_accessor :duration_period
+
+    # Period, in days, for which historical data may be requested; measured from
+    # request time, not grant time
+    # @return [Integer]
+    attr_accessor :lookback_period
+
+    # The permissioned resource entities
+    # @return [Array[ConsentGrantResourceEntity]]
+    attr_accessor :resources
+
+    # Links for related Consent Grant records
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['status'] = 'status'
+      @_hash['parties'] = 'parties'
+      @_hash['created_time'] = 'createdTime'
+      @_hash['expiration_time'] = 'expirationTime'
+      @_hash['updated_time'] = 'updatedTime'
+      @_hash['duration_type'] = 'durationType'
+      @_hash['duration_period'] = 'durationPeriod'
+      @_hash['lookback_period'] = 'lookbackPeriod'
+      @_hash['resources'] = 'resources'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        status
+        parties
+        created_time
+        expiration_time
+        updated_time
+        duration_type
+        duration_period
+        lookback_period
+        resources
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, status: SKIP, parties: SKIP, created_time: SKIP,
+                   expiration_time: SKIP, updated_time: SKIP,
+                   duration_type: SKIP, duration_period: SKIP,
+                   lookback_period: SKIP, resources: SKIP, links: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @status = status unless status == SKIP
+      @parties = parties unless parties == SKIP
+      @created_time = created_time unless created_time == SKIP
+      @expiration_time = expiration_time unless expiration_time == SKIP
+      @updated_time = updated_time unless updated_time == 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
+      @resources = resources unless resources == SKIP
+      @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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      parties = nil
+      unless hash['parties'].nil?
+        parties = []
+        hash['parties'].each do |structure|
+          parties << (PartyEntity.from_hash(structure) if structure)
+        end
+      end
+
+      parties = SKIP unless hash.key?('parties')
+      created_time = if hash.key?('createdTime')
+                       (DateTimeHelper.from_rfc3339(hash['createdTime']) if hash['createdTime'])
+                     else
+                       SKIP
+                     end
+      expiration_time = if hash.key?('expirationTime')
+                          (DateTimeHelper.from_rfc3339(hash['expirationTime']) if hash['expirationTime'])
+                        else
+                          SKIP
+                        end
+      updated_time = if hash.key?('updatedTime')
+                       (DateTimeHelper.from_rfc3339(hash['updatedTime']) if hash['updatedTime'])
+                     else
+                       SKIP
+                     end
+      duration_type = hash.key?('durationType') ? hash['durationType'] : SKIP
+      duration_period =
+        hash.key?('durationPeriod') ? hash['durationPeriod'] : SKIP
+      lookback_period =
+        hash.key?('lookbackPeriod') ? hash['lookbackPeriod'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      resources = nil
+      unless hash['resources'].nil?
+        resources = []
+        hash['resources'].each do |structure|
+          resources << (ConsentGrantResourceEntity.from_hash(structure) if structure)
+        end
+      end
+
+      resources = SKIP unless hash.key?('resources')
+      # 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.
+      ConsentGrantEntity.new(id: id,
+                             status: status,
+                             parties: parties,
+                             created_time: created_time,
+                             expiration_time: expiration_time,
+                             updated_time: updated_time,
+                             duration_type: duration_type,
+                             duration_period: duration_period,
+                             lookback_period: lookback_period,
+                             resources: resources,
+                             links: links,
+                             additional_properties: additional_properties)
+    end
+
+    def to_custom_created_time
+      DateTimeHelper.to_rfc3339(created_time)
+    end
+
+    def to_custom_expiration_time
+      DateTimeHelper.to_rfc3339(expiration_time)
+    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} id: #{@id}, status: #{@status}, parties: #{@parties}, created_time:"\
+      " #{@created_time}, expiration_time: #{@expiration_time}, updated_time: #{@updated_time},"\
+      " duration_type: #{@duration_type}, duration_period: #{@duration_period}, lookback_period:"\
+      " #{@lookback_period}, resources: #{@resources}, 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} id: #{@id.inspect}, status: #{@status.inspect}, parties:"\
+      " #{@parties.inspect}, created_time: #{@created_time.inspect}, expiration_time:"\
+      " #{@expiration_time.inspect}, updated_time: #{@updated_time.inspect}, duration_type:"\
+      " #{@duration_type.inspect}, duration_period: #{@duration_period.inspect}, lookback_period:"\
+      " #{@lookback_period.inspect}, resources: #{@resources.inspect}, links: #{@links.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/consent_grant_resource_entity.rb

@@ -0,0 +1,92 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Entity of permissioned resources
+  class ConsentGrantResourceEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of resource to be permissioned
+    # @return [ConsentResourceType3]
+    attr_accessor :resource_type
+
+    # Identifier of resource to be permissioned
+    # @return [String]
+    attr_accessor :resource_id
+
+    # Names of clusters of data elements permissioned
+    # @return [Array[DataCluster]]
+    attr_accessor :data_clusters
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['resource_type'] = 'resourceType'
+      @_hash['resource_id'] = 'resourceId'
+      @_hash['data_clusters'] = 'dataClusters'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(resource_type:, resource_id:, data_clusters:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @resource_type = resource_type
+      @resource_id = resource_id
+      @data_clusters = data_clusters
+      @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.
+      resource_type = hash.key?('resourceType') ? hash['resourceType'] : nil
+      resource_id = hash.key?('resourceId') ? hash['resourceId'] : nil
+      data_clusters = hash.key?('dataClusters') ? hash['dataClusters'] : nil
+
+      # 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.
+      ConsentGrantResourceEntity.new(resource_type: resource_type,
+                                     resource_id: resource_id,
+                                     data_clusters: data_clusters,
+                                     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} resource_type: #{@resource_type}, resource_id: #{@resource_id},"\
+      " data_clusters: #{@data_clusters}, 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} resource_type: #{@resource_type.inspect}, resource_id:"\
+      " #{@resource_id.inspect}, data_clusters: #{@data_clusters.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/consent_grant_status.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Current status of Consent Grant
+  class ConsentGrantStatus
+    CONSENT_GRANT_STATUS = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for EXPIRED
+      EXPIRED = 'EXPIRED'.freeze,
+
+      # TODO: Write general description for REVOKED
+      REVOKED = 'REVOKED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/consent_grant_status1.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The status of the consent = REVOKED
+  class ConsentGrantStatus1
+    CONSENT_GRANT_STATUS1 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for EXPIRED
+      EXPIRED = 'EXPIRED'.freeze,
+
+      # TODO: Write general description for REVOKED
+      REVOKED = 'REVOKED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/consent_grant_status3.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The current status of the consent
+  class ConsentGrantStatus3
+    CONSENT_GRANT_STATUS3 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for EXPIRED
+      EXPIRED = 'EXPIRED'.freeze,
+
+      # TODO: Write general description for REVOKED
+      REVOKED = 'REVOKED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/consent_request_entity.rb

@@ -0,0 +1,121 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Details of request to create new consent grant. This schema is to be used in
+  # POST request to Data Provider's `POST /par` endpoint using the Pushed
+  # Authorization Request (PAR) method
+  class ConsentRequestEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of duration of the consent
+    # @return [ConsentDurationType]
+    attr_accessor :duration_type
+
+    # The consent duration in days from day of original grant
+    # @return [Integer]
+    attr_accessor :duration_period
+
+    # Period, in days, for which historical data may be requested; measured from
+    # request time, not grant time
+    # @return [Integer]
+    attr_accessor :lookback_period
+
+    # The requested resource entities
+    # @return [Array[ConsentRequestedResourceEntity]]
+    attr_accessor :resources
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['duration_type'] = 'durationType'
+      @_hash['duration_period'] = 'durationPeriod'
+      @_hash['lookback_period'] = 'lookbackPeriod'
+      @_hash['resources'] = 'resources'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        duration_type
+        duration_period
+        lookback_period
+        resources
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(duration_type: SKIP, duration_period: SKIP,
+                   lookback_period: SKIP, resources: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @duration_type = duration_type unless duration_type == SKIP
+      @duration_period = duration_period unless duration_period == SKIP
+      @lookback_period = lookback_period unless lookback_period == SKIP
+      @resources = resources unless resources == 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.
+      duration_type = hash.key?('durationType') ? hash['durationType'] : SKIP
+      duration_period =
+        hash.key?('durationPeriod') ? hash['durationPeriod'] : SKIP
+      lookback_period =
+        hash.key?('lookbackPeriod') ? hash['lookbackPeriod'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      resources = nil
+      unless hash['resources'].nil?
+        resources = []
+        hash['resources'].each do |structure|
+          resources << (ConsentRequestedResourceEntity.from_hash(structure) if structure)
+        end
+      end
+
+      resources = SKIP unless hash.key?('resources')
+
+      # 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.
+      ConsentRequestEntity.new(duration_type: duration_type,
+                               duration_period: duration_period,
+                               lookback_period: lookback_period,
+                               resources: resources,
+                               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} duration_type: #{@duration_type}, duration_period: #{@duration_period},"\
+      " lookback_period: #{@lookback_period}, resources: #{@resources}, 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} duration_type: #{@duration_type.inspect}, duration_period:"\
+      " #{@duration_period.inspect}, lookback_period: #{@lookback_period.inspect}, resources:"\
+      " #{@resources.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/consent_requested_resource_entity.rb

@@ -0,0 +1,82 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Details of requested resource and data clusters
+  class ConsentRequestedResourceEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of resource permission requested
+    # @return [ConsentResourceType1]
+    attr_accessor :resource_type
+
+    # Names of clusters of data elements requested
+    # @return [Array[DataCluster]]
+    attr_accessor :data_clusters
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['resource_type'] = 'resourceType'
+      @_hash['data_clusters'] = 'dataClusters'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(resource_type:, data_clusters:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @resource_type = resource_type
+      @data_clusters = data_clusters
+      @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.
+      resource_type = hash.key?('resourceType') ? hash['resourceType'] : nil
+      data_clusters = hash.key?('dataClusters') ? hash['dataClusters'] : nil
+
+      # 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.
+      ConsentRequestedResourceEntity.new(resource_type: resource_type,
+                                         data_clusters: data_clusters,
+                                         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} resource_type: #{@resource_type}, data_clusters: #{@data_clusters},"\
+      " 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} resource_type: #{@resource_type.inspect}, data_clusters:"\
+      " #{@data_clusters.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/consent_resource_type.rb

@@ -0,0 +1,27 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Resource for which data may be permissioned; can be extended to support
+  # additional types of resources
+  class ConsentResourceType
+    CONSENT_RESOURCE_TYPE = [
+      # TODO: Write general description for ACCOUNT
+      ACCOUNT = 'ACCOUNT'.freeze,
+
+      # TODO: Write general description for CUSTOMER
+      CUSTOMER = 'CUSTOMER'.freeze,
+
+      # TODO: Write general description for DOCUMENT
+      DOCUMENT = 'DOCUMENT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/consent_resource_type1.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of resource permission requested
+  class ConsentResourceType1
+    CONSENT_RESOURCE_TYPE1 = [
+      # TODO: Write general description for ACCOUNT
+      ACCOUNT = 'ACCOUNT'.freeze,
+
+      # TODO: Write general description for CUSTOMER
+      CUSTOMER = 'CUSTOMER'.freeze,
+
+      # TODO: Write general description for DOCUMENT
+      DOCUMENT = 'DOCUMENT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/consent_resource_type3.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of resource to be permissioned
+  class ConsentResourceType3
+    CONSENT_RESOURCE_TYPE3 = [
+      # TODO: Write general description for ACCOUNT
+      ACCOUNT = 'ACCOUNT'.freeze,
+
+      # TODO: Write general description for CUSTOMER
+      CUSTOMER = 'CUSTOMER'.freeze,
+
+      # TODO: Write general description for DOCUMENT
+      DOCUMENT = 'DOCUMENT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end