Module: FREDAPI::Client::Source::Releases

Included in:

FREDAPI::Client::Source

Defined in:

lib/fredapi/client/source/releases.rb

Overview

Releases module for fred/source/releases endpoint

Instance Method Summary

• #source_releases(opts = {}) ⇒ Hashie::Mash

  Get the releases for a source.

Instance Method Details

#source_releases(opts = {}) ⇒ Hashie::Mash

Get the releases for a source

Parameters:

• opts (Hash) (defaults to: {}) —

  options hash of parameters

Options Hash (opts):

• api_key (Integer) —

  32 character alpha-numeric lowercase string

• file_type (String) —

  A key or file extension that indicates the type

• source_id (Integer) —

  The id for a source

• realtime_start (String) —

  The start of the real-time period

• realtime_end (String) —

  The end of the real-time period

• limit (Integer) —

  The maximum number of results to return

• offset (Integer) —

  Non-negative integer

• order_by (String) —

  Order results by values of the specified attribute

• sort_order (String) —

  Sort results is ascending or descending order for attribute values specified by order_by

Returns:

• (Hashie::Mash) —

  Hash containing the results

# File 'lib/fredapi/client/source/releases.rb', line 20

def source_releases opts={}
  get "fred/source/releases", opts
end