Module: FREDAPI::Client::Category

Includes:

Children, Related, RelatedTags, Series, Tags

Included in:

FREDAPI::Client

Defined in:

lib/fredapi/client/category.rb,
lib/fredapi/client/category/tags.rb,
lib/fredapi/client/category/series.rb,
lib/fredapi/client/category/related.rb,
lib/fredapi/client/category/children.rb,
lib/fredapi/client/category/related_tags.rb

Overview

Category module for fred/category endpoint

Defined Under Namespace

Modules: Children, Related, RelatedTags, Series, Tags

Instance Method Summary

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

  Get a category.

Methods included from Tags

#category_tags

Methods included from Series

#category_series

Methods included from RelatedTags

#category_related_tags

Methods included from Related

#category_related

Methods included from Children

#category_children

Instance Method Details

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

Get a category

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 of file to send

• category_id (Integer) —

  The id for a category

Returns:

• (Hashie::Mash) —

  Hash containing the results

# File 'lib/fredapi/client/category.rb', line 19

def category opts={}
  get "fred/category", opts
end