chainlink-apimatic-sdk 0.0.1 → 0.0.2

data/lib/ccip_directory_and_configuration_rest_api_v1/models/lane_details.rb

@@ -0,0 +1,116 @@
+# ccip_directory_and_configuration_rest_api_v1
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CcipDirectoryAndConfigurationRestApiV1
+  # LaneDetails Model.
+  class LaneDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Chain information used in lane endpoints. Note: chainType and chainFamily
+    # are intentionally excluded from this schema for API responses.
+    # @return [ChainInfo]
+    attr_accessor :source_chain
+
+    # Chain information used in lane endpoints. Note: chainType and chainFamily
+    # are intentionally excluded from this schema for API responses.
+    # @return [ChainInfo]
+    attr_accessor :destination_chain
+
+    # Chain information used in lane endpoints. Note: chainType and chainFamily
+    # are intentionally excluded from this schema for API responses.
+    # @return [OnRamp]
+    attr_accessor :on_ramp
+
+    # Chain information used in lane endpoints. Note: chainType and chainFamily
+    # are intentionally excluded from this schema for API responses.
+    # @return [OffRamp]
+    attr_accessor :off_ramp
+
+    # List of supported token keys (e.g., LINK, CCIP-BnM, USDC)
+    # @return [Array[String]]
+    attr_accessor :supported_tokens
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['source_chain'] = 'sourceChain'
+      @_hash['destination_chain'] = 'destinationChain'
+      @_hash['on_ramp'] = 'onRamp'
+      @_hash['off_ramp'] = 'offRamp'
+      @_hash['supported_tokens'] = 'supportedTokens'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(source_chain:, destination_chain:, on_ramp:, off_ramp:,
+                   supported_tokens:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @source_chain = source_chain
+      @destination_chain = destination_chain
+      @on_ramp = on_ramp
+      @off_ramp = off_ramp
+      @supported_tokens = supported_tokens
+      @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.
+      source_chain = ChainInfo.from_hash(hash['sourceChain']) if hash['sourceChain']
+      destination_chain = ChainInfo.from_hash(hash['destinationChain']) if
+        hash['destinationChain']
+      on_ramp = OnRamp.from_hash(hash['onRamp']) if hash['onRamp']
+      off_ramp = OffRamp.from_hash(hash['offRamp']) if hash['offRamp']
+      supported_tokens =
+        hash.key?('supportedTokens') ? hash['supportedTokens'] : 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.
+      LaneDetails.new(source_chain: source_chain,
+                      destination_chain: destination_chain,
+                      on_ramp: on_ramp,
+                      off_ramp: off_ramp,
+                      supported_tokens: supported_tokens,
+                      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} source_chain: #{@source_chain}, destination_chain: #{@destination_chain},"\
+      " on_ramp: #{@on_ramp}, off_ramp: #{@off_ramp}, supported_tokens: #{@supported_tokens},"\
+      " 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} source_chain: #{@source_chain.inspect}, destination_chain:"\
+      " #{@destination_chain.inspect}, on_ramp: #{@on_ramp.inspect}, off_ramp:"\
+      " #{@off_ramp.inspect}, supported_tokens: #{@supported_tokens.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/ccip_directory_and_configuration_rest_api_v1/models/lane_metadata.rb

@@ -0,0 +1,119 @@
+# ccip_directory_and_configuration_rest_api_v1
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module CcipDirectoryAndConfigurationRestApiV1
+  # LaneMetadata Model.
+  class LaneMetadata < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The network environment
+    # @return [Environment]
+    attr_accessor :environment
+
+    # ISO timestamp of the response
+    # @return [DateTime]
+    attr_accessor :timestamp
+
+    # Unique identifier for the request
+    # @return [UUID | String]
+    attr_accessor :request_id
+
+    # Number of lanes ignored due to configuration issues
+    # @return [Integer]
+    attr_accessor :ignored_lane_count
+
+    # Number of valid lanes in the response
+    # @return [Integer]
+    attr_accessor :valid_lane_count
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['environment'] = 'environment'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['request_id'] = 'requestId'
+      @_hash['ignored_lane_count'] = 'ignoredLaneCount'
+      @_hash['valid_lane_count'] = 'validLaneCount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(environment:, timestamp:, request_id:, ignored_lane_count:,
+                   valid_lane_count:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @environment = environment
+      @timestamp = timestamp
+      @request_id = request_id
+      @ignored_lane_count = ignored_lane_count
+      @valid_lane_count = valid_lane_count
+      @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.
+      environment = hash.key?('environment') ? hash['environment'] : nil
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  end
+      request_id = hash.key?('requestId') ? hash['requestId'] : nil
+      ignored_lane_count =
+        hash.key?('ignoredLaneCount') ? hash['ignoredLaneCount'] : nil
+      valid_lane_count =
+        hash.key?('validLaneCount') ? hash['validLaneCount'] : 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.
+      LaneMetadata.new(environment: environment,
+                       timestamp: timestamp,
+                       request_id: request_id,
+                       ignored_lane_count: ignored_lane_count,
+                       valid_lane_count: valid_lane_count,
+                       additional_properties: additional_properties)
+    end
+
+    def to_custom_timestamp
+      DateTimeHelper.to_rfc3339(timestamp)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} environment: #{@environment}, timestamp: #{@timestamp}, request_id:"\
+      " #{@request_id}, ignored_lane_count: #{@ignored_lane_count}, valid_lane_count:"\
+      " #{@valid_lane_count}, 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} environment: #{@environment.inspect}, timestamp: #{@timestamp.inspect},"\
+      " request_id: #{@request_id.inspect}, ignored_lane_count: #{@ignored_lane_count.inspect},"\
+      " valid_lane_count: #{@valid_lane_count.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/ccip_directory_and_configuration_rest_api_v1/models/off_ramp.rb

@@ -0,0 +1,82 @@
+# ccip_directory_and_configuration_rest_api_v1
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CcipDirectoryAndConfigurationRestApiV1
+  # OffRamp Model.
+  class OffRamp < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # OffRamp contract address
+    # @return [String]
+    attr_accessor :address
+
+    # Normalized semantic version of the OffRamp contract
+    # @return [String]
+    attr_accessor :version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address'] = 'address'
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address:, version:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @address = address
+      @version = version
+      @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.
+      address = hash.key?('address') ? hash['address'] : nil
+      version = hash.key?('version') ? hash['version'] : 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.
+      OffRamp.new(address: address,
+                  version: version,
+                  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} address: #{@address}, version: #{@version}, 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} address: #{@address.inspect}, version: #{@version.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/ccip_directory_and_configuration_rest_api_v1/models/on_ramp.rb

@@ -0,0 +1,95 @@
+# ccip_directory_and_configuration_rest_api_v1
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CcipDirectoryAndConfigurationRestApiV1
+  # OnRamp Model.
+  class OnRamp < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # OnRamp contract address
+    # @return [String]
+    attr_accessor :address
+
+    # Normalized semantic version of the OnRamp contract
+    # @return [String]
+    attr_accessor :version
+
+    # Whether the OnRamp enforces out-of-order execution
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enforce_out_of_order
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address'] = 'address'
+      @_hash['version'] = 'version'
+      @_hash['enforce_out_of_order'] = 'enforceOutOfOrder'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        enforce_out_of_order
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address:, version:, enforce_out_of_order: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @address = address
+      @version = version
+      @enforce_out_of_order = enforce_out_of_order unless enforce_out_of_order == 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.
+      address = hash.key?('address') ? hash['address'] : nil
+      version = hash.key?('version') ? hash['version'] : nil
+      enforce_out_of_order =
+        hash.key?('enforceOutOfOrder') ? hash['enforceOutOfOrder'] : 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.
+      OnRamp.new(address: address,
+                 version: version,
+                 enforce_out_of_order: enforce_out_of_order,
+                 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} address: #{@address}, version: #{@version}, enforce_out_of_order:"\
+      " #{@enforce_out_of_order}, 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} address: #{@address.inspect}, version: #{@version.inspect},"\
+      " enforce_out_of_order: #{@enforce_out_of_order.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/ccip_directory_and_configuration_rest_api_v1/models/output_key.rb

@@ -0,0 +1,40 @@
+# ccip_directory_and_configuration_rest_api_v1
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CcipDirectoryAndConfigurationRestApiV1
+  # outputKey.
+  class OutputKey
+    OUTPUT_KEY = [
+      # TODO: Write general description for CHAINID
+      CHAINID = 'chainId'.freeze,
+
+      # TODO: Write general description for SELECTOR
+      SELECTOR = 'selector'.freeze,
+
+      # TODO: Write general description for INTERNALID
+      INTERNALID = 'internalId'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OUTPUT_KEY.include?(value)
+    end
+
+    def self.from_value(value, default_value = CHAINID)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'chainid' then CHAINID
+      when 'selector' then SELECTOR
+      when 'internalid' then INTERNALID
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/ccip_directory_and_configuration_rest_api_v1/models/pool_type.rb

@@ -0,0 +1,44 @@
+# ccip_directory_and_configuration_rest_api_v1
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CcipDirectoryAndConfigurationRestApiV1
+  # Type of pool for this token
+  class PoolType
+    POOL_TYPE = [
+      # TODO: Write general description for LOCKRELEASE
+      LOCKRELEASE = 'lockRelease'.freeze,
+
+      # TODO: Write general description for BURNMINT
+      BURNMINT = 'burnMint'.freeze,
+
+      # TODO: Write general description for USDC
+      USDC = 'usdc'.freeze,
+
+      # TODO: Write general description for FEETOKENONLY
+      FEETOKENONLY = 'feeTokenOnly'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      POOL_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = LOCKRELEASE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'lockrelease' then LOCKRELEASE
+      when 'burnmint' then BURNMINT
+      when 'usdc' then USDC
+      when 'feetokenonly' then FEETOKENONLY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/ccip_directory_and_configuration_rest_api_v1/models/search_type.rb

@@ -0,0 +1,46 @@
+# ccip_directory_and_configuration_rest_api_v1
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CcipDirectoryAndConfigurationRestApiV1
+  # The detected type of search query. 'selector' for CCIP selectors (>17
+  # digits), 'chainId' for chain IDs (≤17 digits or Solana base58), 'internalId'
+  # for kebab-case identifiers, 'displayName' for fuzzy text search.
+  class SearchType
+    SEARCH_TYPE = [
+      # TODO: Write general description for SELECTOR
+      SELECTOR = 'selector'.freeze,
+
+      # TODO: Write general description for CHAINID
+      CHAINID = 'chainId'.freeze,
+
+      # TODO: Write general description for INTERNALID
+      INTERNALID = 'internalId'.freeze,
+
+      # TODO: Write general description for DISPLAYNAME
+      DISPLAYNAME = 'displayName'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SEARCH_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = SELECTOR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'selector' then SELECTOR
+      when 'chainid' then CHAINID
+      when 'internalid' then INTERNALID
+      when 'displayname' then DISPLAYNAME
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/ccip_directory_and_configuration_rest_api_v1/models/token_api_response.rb

@@ -0,0 +1,101 @@
+# ccip_directory_and_configuration_rest_api_v1
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module CcipDirectoryAndConfigurationRestApiV1
+  # TokenApiResponse Model.
+  class TokenApiResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TokenMetadata]
+    attr_accessor :metadata
+
+    # Token data indexed by token symbol and then by chain ID/selector
+    # @return [Hash[String, TokenChainData]]
+    attr_accessor :data
+
+    # List of tokens that were ignored due to configuration issues
+    # @return [Array[TokenConfigError]]
+    attr_accessor :ignored
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['data'] = 'data'
+      @_hash['ignored'] = 'ignored'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metadata:, data:, ignored:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata
+      @data = data
+      @ignored = ignored
+      @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.
+      metadata = TokenMetadata.from_hash(hash['metadata']) if hash['metadata']
+      data = TokenChainData.from_hash(hash['data']) if hash['data']
+
+      data = nil unless hash.key?('data')
+      # Parameter is an array, so we need to iterate through it
+      ignored = nil
+      unless hash['ignored'].nil?
+        ignored = []
+        hash['ignored'].each do |structure|
+          ignored << (TokenConfigError.from_hash(structure) if structure)
+        end
+      end
+
+      ignored = nil unless hash.key?('ignored')
+
+      # 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.
+      TokenApiResponse.new(metadata: metadata,
+                           data: data,
+                           ignored: ignored,
+                           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} metadata: #{@metadata}, data: #{@data}, ignored: #{@ignored},"\
+      " 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} metadata: #{@metadata.inspect}, data: #{@data.inspect}, ignored:"\
+      " #{@ignored.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end