fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/business_or_consumer_type.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of entity. One of BUSINESS or CONSUMER
+  class BusinessOrConsumerType
+    BUSINESS_OR_CONSUMER_TYPE = [
+      # TODO: Write general description for BUSINESS
+      BUSINESS = 'BUSINESS'.freeze,
+
+      # TODO: Write general description for CONSUMER
+      CONSUMER = 'CONSUMER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/business_or_consumer_type1.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # BUSINESS or CONSUMER membership
+  class BusinessOrConsumerType1
+    BUSINESS_OR_CONSUMER_TYPE1 = [
+      # TODO: Write general description for BUSINESS
+      BUSINESS = 'BUSINESS'.freeze,
+
+      # TODO: Write general description for CONSUMER
+      CONSUMER = 'CONSUMER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/call_type.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The call type for a stock option
+  class CallType
+    CALL_TYPE = [
+      # TODO: Write general description for CALL
+      CALL = 'CALL'.freeze,
+
+      # TODO: Write general description for MATURITY
+      MATURITY = 'MATURITY'.freeze,
+
+      # TODO: Write general description for PREFUND
+      PREFUND = 'PREFUND'.freeze,
+
+      # TODO: Write general description for PUT
+      PUT = 'PUT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/call_type2.rb

@@ -0,0 +1,29 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of next call. One of CALL, PUT, PREFUND, MATURITY
+  class CallType2
+    CALL_TYPE2 = [
+      # TODO: Write general description for CALL
+      CALL = 'CALL'.freeze,
+
+      # TODO: Write general description for MATURITY
+      MATURITY = 'MATURITY'.freeze,
+
+      # TODO: Write general description for PREFUND
+      PREFUND = 'PREFUND'.freeze,
+
+      # TODO: Write general description for PUT
+      PUT = 'PUT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/capability_entity.rb

@@ -0,0 +1,139 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The response object for the API /capability request
+  class CapabilityEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The FDX schema versions supported by one or more operations
+    # @return [Array[FdxVersion]]
+    attr_accessor :fdx_versions
+
+    # The number of concurrent connections allowed for this client
+    # @return [Integer]
+    attr_accessor :allowed_connections
+
+    # The current number of active connections for this client
+    # @return [Integer]
+    attr_accessor :active_connections
+
+    # Defaults to JSON
+    # @return [MessageFormat2]
+    attr_accessor :message_format
+
+    # The FDX API endpoints supported
+    # @return [Array[OperationEntity]]
+    attr_accessor :operations
+
+    # The URL to retrieve the JWKS public keys from the data provider, needed to
+    # enable payload level encryption above the TLS layer
+    # @return [HateoasLink]
+    attr_accessor :jwks_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['fdx_versions'] = 'fdxVersions'
+      @_hash['allowed_connections'] = 'allowedConnections'
+      @_hash['active_connections'] = 'activeConnections'
+      @_hash['message_format'] = 'messageFormat'
+      @_hash['operations'] = 'operations'
+      @_hash['jwks_url'] = 'jwksUrl'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        fdx_versions
+        allowed_connections
+        active_connections
+        message_format
+        operations
+        jwks_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(fdx_versions: SKIP, allowed_connections: SKIP,
+                   active_connections: SKIP, message_format: SKIP,
+                   operations: SKIP, jwks_url: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @fdx_versions = fdx_versions unless fdx_versions == SKIP
+      @allowed_connections = allowed_connections unless allowed_connections == SKIP
+      @active_connections = active_connections unless active_connections == SKIP
+      @message_format = message_format unless message_format == SKIP
+      @operations = operations unless operations == SKIP
+      @jwks_url = jwks_url unless jwks_url == 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.
+      fdx_versions = hash.key?('fdxVersions') ? hash['fdxVersions'] : SKIP
+      allowed_connections =
+        hash.key?('allowedConnections') ? hash['allowedConnections'] : SKIP
+      active_connections =
+        hash.key?('activeConnections') ? hash['activeConnections'] : SKIP
+      message_format = hash.key?('messageFormat') ? hash['messageFormat'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      operations = nil
+      unless hash['operations'].nil?
+        operations = []
+        hash['operations'].each do |structure|
+          operations << (OperationEntity.from_hash(structure) if structure)
+        end
+      end
+
+      operations = SKIP unless hash.key?('operations')
+      jwks_url = HateoasLink.from_hash(hash['jwksUrl']) if hash['jwksUrl']
+
+      # 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.
+      CapabilityEntity.new(fdx_versions: fdx_versions,
+                           allowed_connections: allowed_connections,
+                           active_connections: active_connections,
+                           message_format: message_format,
+                           operations: operations,
+                           jwks_url: jwks_url,
+                           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} fdx_versions: #{@fdx_versions}, allowed_connections:"\
+      " #{@allowed_connections}, active_connections: #{@active_connections}, message_format:"\
+      " #{@message_format}, operations: #{@operations}, jwks_url: #{@jwks_url},"\
+      " 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} fdx_versions: #{@fdx_versions.inspect}, allowed_connections:"\
+      " #{@allowed_connections.inspect}, active_connections: #{@active_connections.inspect},"\
+      " message_format: #{@message_format.inspect}, operations: #{@operations.inspect}, jwks_url:"\
+      " #{@jwks_url.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/card_art_entity.rb

@@ -0,0 +1,91 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Art associated with the card
+  class CardArtEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Display label for the specific image
+    # @return [String]
+    attr_accessor :label
+
+    # The [URI](https://datatracker.ietf.org/doc/html/rfc2397) link of a PNG,
+    # JPG or GIF image with proportions defined by [ISO 8710
+    # ID-1](https://en.wikipedia.org/wiki/ISO/IEC_7810) with 340x210 ratio and
+    # width no greater than 512 pixels. The image at this URI must be accessible
+    # at all times, with no additional authentication headers. Typically this is
+    # an image resource located in the data provider's public web site or
+    # Content Delivery Network
+    # @return [String]
+    attr_accessor :image_uri
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['label'] = 'label'
+      @_hash['image_uri'] = 'imageUri'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        label
+        image_uri
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(label: SKIP, image_uri: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @label = label unless label == SKIP
+      @image_uri = image_uri unless image_uri == 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.
+      label = hash.key?('label') ? hash['label'] : SKIP
+      image_uri = hash.key?('imageUri') ? hash['imageUri'] : 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.
+      CardArtEntity.new(label: label,
+                        image_uri: image_uri,
+                        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} label: #{@label}, image_uri: #{@image_uri}, 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} label: #{@label.inspect}, image_uri: #{@image_uri.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/card_art_entity2.rb

@@ -0,0 +1,101 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Any Art associated to the Card related to the account
+  class CardArtEntity2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Display label for the specific image
+    # @return [String]
+    attr_accessor :label
+
+    # The [URI](https://datatracker.ietf.org/doc/html/rfc2397) link of a PNG,
+    # JPG or GIF image with proportions defined by [ISO 8710
+    # ID-1](https://en.wikipedia.org/wiki/ISO/IEC_7810) with 340x210 ratio and
+    # width no greater than 512 pixels. The image at this URI must be accessible
+    # at all times, with no additional authentication headers. Typically this is
+    # an image resource located in the data provider's public web site or
+    # Content Delivery Network
+    # @return [String]
+    attr_accessor :image_uri
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['label'] = 'label'
+      @_hash['image_uri'] = 'imageUri'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        label
+        image_uri
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(label: SKIP, image_uri: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @label = label unless label == SKIP
+      @image_uri = image_uri unless image_uri == 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.
+      label = hash.key?('label') ? hash['label'] : SKIP
+      image_uri = hash.key?('imageUri') ? hash['imageUri'] : 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.
+      CardArtEntity2.new(label: label,
+                         image_uri: image_uri,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CardArtEntity2 | 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} label: #{@label}, image_uri: #{@image_uri}, 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} label: #{@label.inspect}, image_uri: #{@image_uri.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/certification_metric_entity.rb

@@ -0,0 +1,172 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxApi
+  # A single certification performance metric
+  class CertificationMetricEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When the reported metrics period began
+    # @return [DateTime]
+    attr_accessor :report_start_timestamp
+
+    # When the reported metrics period ended
+    # @return [DateTime]
+    attr_accessor :report_end_timestamp
+
+    # Any provider descriptive name for the measurement. Optional, can be
+    # omitted if operationIds are returned
+    # @return [String]
+    attr_accessor :metrics_name
+
+    # One or more Operation IDs for which these metrics apply. Optional, can be
+    # omitted if metricsName is returned
+    # @return [Array[FdxResourceOperationId]]
+    attr_accessor :operation_ids
+
+    # The self-reported average response time in milliseconds for all combined
+    # data responses
+    # @return [Float]
+    attr_accessor :response_time_average
+
+    # See the Certification Performance section that describes how this
+    # measurement will be calculated, defines the % of availability during the
+    # measurement
+    # @return [Float]
+    attr_accessor :average_up_time
+
+    # Time when these performance and availability metrics were created
+    # @return [DateTime]
+    attr_accessor :report_timestamp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['report_start_timestamp'] = 'reportStartTimestamp'
+      @_hash['report_end_timestamp'] = 'reportEndTimestamp'
+      @_hash['metrics_name'] = 'metricsName'
+      @_hash['operation_ids'] = 'operationIds'
+      @_hash['response_time_average'] = 'responseTimeAverage'
+      @_hash['average_up_time'] = 'averageUpTime'
+      @_hash['report_timestamp'] = 'reportTimestamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        report_start_timestamp
+        report_end_timestamp
+        metrics_name
+        operation_ids
+        response_time_average
+        average_up_time
+        report_timestamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(report_start_timestamp: SKIP, report_end_timestamp: SKIP,
+                   metrics_name: SKIP, operation_ids: SKIP,
+                   response_time_average: SKIP, average_up_time: SKIP,
+                   report_timestamp: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @report_start_timestamp = report_start_timestamp unless report_start_timestamp == SKIP
+      @report_end_timestamp = report_end_timestamp unless report_end_timestamp == SKIP
+      @metrics_name = metrics_name unless metrics_name == SKIP
+      @operation_ids = operation_ids unless operation_ids == SKIP
+      @response_time_average = response_time_average unless response_time_average == SKIP
+      @average_up_time = average_up_time unless average_up_time == SKIP
+      @report_timestamp = report_timestamp unless report_timestamp == 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.
+      report_start_timestamp = if hash.key?('reportStartTimestamp')
+                                 (DateTimeHelper.from_rfc3339(hash['reportStartTimestamp']) if hash['reportStartTimestamp'])
+                               else
+                                 SKIP
+                               end
+      report_end_timestamp = if hash.key?('reportEndTimestamp')
+                               (DateTimeHelper.from_rfc3339(hash['reportEndTimestamp']) if hash['reportEndTimestamp'])
+                             else
+                               SKIP
+                             end
+      metrics_name = hash.key?('metricsName') ? hash['metricsName'] : SKIP
+      operation_ids = hash.key?('operationIds') ? hash['operationIds'] : SKIP
+      response_time_average =
+        hash.key?('responseTimeAverage') ? hash['responseTimeAverage'] : SKIP
+      average_up_time =
+        hash.key?('averageUpTime') ? hash['averageUpTime'] : SKIP
+      report_timestamp = if hash.key?('reportTimestamp')
+                           (DateTimeHelper.from_rfc3339(hash['reportTimestamp']) if hash['reportTimestamp'])
+                         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.
+      CertificationMetricEntity.new(report_start_timestamp: report_start_timestamp,
+                                    report_end_timestamp: report_end_timestamp,
+                                    metrics_name: metrics_name,
+                                    operation_ids: operation_ids,
+                                    response_time_average: response_time_average,
+                                    average_up_time: average_up_time,
+                                    report_timestamp: report_timestamp,
+                                    additional_properties: additional_properties)
+    end
+
+    def to_custom_report_start_timestamp
+      DateTimeHelper.to_rfc3339(report_start_timestamp)
+    end
+
+    def to_custom_report_end_timestamp
+      DateTimeHelper.to_rfc3339(report_end_timestamp)
+    end
+
+    def to_custom_report_timestamp
+      DateTimeHelper.to_rfc3339(report_timestamp)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} report_start_timestamp: #{@report_start_timestamp}, report_end_timestamp:"\
+      " #{@report_end_timestamp}, metrics_name: #{@metrics_name}, operation_ids:"\
+      " #{@operation_ids}, response_time_average: #{@response_time_average}, average_up_time:"\
+      " #{@average_up_time}, report_timestamp: #{@report_timestamp}, 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} report_start_timestamp: #{@report_start_timestamp.inspect},"\
+      " report_end_timestamp: #{@report_end_timestamp.inspect}, metrics_name:"\
+      " #{@metrics_name.inspect}, operation_ids: #{@operation_ids.inspect}, response_time_average:"\
+      " #{@response_time_average.inspect}, average_up_time: #{@average_up_time.inspect},"\
+      " report_timestamp: #{@report_timestamp.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/certification_metrics_entity.rb

@@ -0,0 +1,84 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Response object for /certification-metrics API
+  class CertificationMetricsEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Zero or more certification performance metrics
+    # @return [Array[CertificationMetricEntity]]
+    attr_accessor :metrics
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metrics'] = 'metrics'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metrics
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metrics: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metrics = metrics unless metrics == 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
+      metrics = nil
+      unless hash['metrics'].nil?
+        metrics = []
+        hash['metrics'].each do |structure|
+          metrics << (CertificationMetricEntity.from_hash(structure) if structure)
+        end
+      end
+
+      metrics = SKIP unless hash.key?('metrics')
+
+      # 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.
+      CertificationMetricsEntity.new(metrics: metrics,
+                                     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} metrics: #{@metrics}, 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} metrics: #{@metrics.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end