fredapi 1.0.0

data/lib/fredapi/client/release/related_tags.rb

@@ -0,0 +1,30 @@
+module FREDAPI
+  class Client
+    module Release
+      # RelatedTags module for fred/release/related_tags endpoint
+      module RelatedTags
+
+        # Get the related tags for a release
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+        # @option opts [String] file_type A key or file extension that indicates the type of file to send
+        # @option opts [Integer] release_id The id for a release
+        # @option opts [String] realtime_start The start of the real-time period
+        # @option opts [String] realtime_end The end of the real-time period
+        # @option opts [String] tag_names A semicolon delimited list of tags to find related tags for
+        # @option opts [String] tag_group_id A tag group id to filter tags by type
+        # @option opts [String] search_text The words to find matching tags with
+        # @option opts [Integer] limit The maximum number of results to return
+        # @option opts [Integer] offset Non-negative integer
+        # @option opts [String] order_by Order results by values of the specified attribute
+        # @option opts [String] sort_order Sort results is ascending or descending order for attribute values specified by order_by
+        # @return [Hashie::Mash] Hash containing the results
+        def release_related_tags opts={}
+          get "fred/release/related_tags", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/fredapi/client/release/series.rb

@@ -0,0 +1,30 @@
+module FREDAPI
+  class Client
+    module Release
+      # RelatedTags module for fred/release/series endpoint
+      module Series
+
+        # Get the series on a release of economic data
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+        # @option opts [String] file_type A key or file extension that indicates the type of file to send
+        # @option opts [Integer] release_id The id for a release
+        # @option opts [String] realtime_start The start of the real-time period
+        # @option opts [String] realtime_end The end of the real-time period
+        # @option opts [Integer] limit The maximum number of results to return
+        # @option opts [Integer] offset Non-negative integer
+        # @option opts [String] order_by Order results by values of the specified attribute
+        # @option opts [String] sort_order Sort results is ascending or descending order for attribute values specified by order_by
+        # @option opts [String] filter_variable The attribute to filter results by
+        # @option opts [String] filter_value The attribute to filter results by
+        # @option opts [String] tag_names A semicolon delimited list of tags to find related tags for
+        # @return [Hashie::Mash] Hash containing the results
+        def release_series opts={}
+          get "fred/release/series", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/fredapi/client/release/sources.rb

@@ -0,0 +1,23 @@
+module FREDAPI
+  class Client
+    module Release
+      # Sources module for fred/release/sources endpoint
+      module Sources
+
+        # Get the sources on a release of economic data
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+        # @option opts [String] file_type A key or file extension that indicates the type of file to send
+        # @option opts [Integer] release_id The id for a release
+        # @option opts [String] realtime_start The start of the real-time period
+        # @option opts [String] realtime_end The end of the real-time period
+        # @return [Hashie::Mash] Hash containing the results
+        def release_sources opts={}
+          get "fred/release/sources", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/fredapi/client/release/tags.rb

@@ -0,0 +1,30 @@
+module FREDAPI
+  class Client
+    module Release
+      # Tags module for fred/release/tags endpoint
+      module Tags
+
+        # Get the sources on a release of economic data
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+        # @option opts [String] file_type A key or file extension that indicates the type of file to send
+        # @option opts [Integer] release_id The id for a release
+        # @option opts [String] realtime_start The start of the real-time period
+        # @option opts [String] realtime_end The end of the real-time period
+        # @option opts [String] tag_group_id A tag group id to filter tags by type
+        # @option opts [String] tag_names A semicolon delimited list of tags to find related tags for
+        # @option opts [String] search_text The words to find matching tags with
+        # @option opts [Integer] limit The maximum number of results to return
+        # @option opts [Integer] offset Non-negative integer
+        # @option opts [String] order_by Order results by values of the specified attribute
+        # @option opts [String] sort_order Sort results is ascending or descending order for attribute values specified by order_by
+        # @return [Hashie::Mash] Hash containing the results
+        def release_tags opts={}
+          get "fred/release/tags", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/fredapi/client/releases.rb

@@ -0,0 +1,29 @@
+require 'fredapi/client/releases/dates'
+
+module FREDAPI
+  class Client
+    # Releases module for fred/releases endpoint
+    module Releases
+
+      # Get all releases of economic data
+      #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+      # @option opts [String] file_type A key or file extension that indicates the type of file to send
+      # @option opts [Integer] category_id The id for a category
+      # @option opts [String] realtime_start The start of the real-time period
+      # @option opts [String] realtime_end The end of the real-time period
+      # @option opts [Integer] limit The maximum number of results to return
+      # @option opts [Integer] offset Non-negative integer
+      # @option opts [String] order_by Order results by values of the specified attribute
+      # @option opts [String] sort_order Sort results is ascending or descending order for attribute values specified by order_by
+      # @return [Hashie::Mash] Hash containing the results
+      def releases opts={}
+        get "fred/releases", opts
+      end
+
+      include FREDAPI::Client::Releases::Dates
+
+    end
+  end
+end

data/lib/fredapi/client/releases/dates.rb

@@ -0,0 +1,27 @@
+module FREDAPI
+  class Client
+    module Releases
+      # Dates module for fred/releases/dates endpoint
+      module Dates
+
+        # Get releases dates for all releases of economic data
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+        # @option opts [String] file_type A key or file extension that indicates the type of file to send
+        # @option opts [String] realtime_start The start of the real-time period
+        # @option opts [String] realtime_end The end of the real-time period
+        # @option opts [Integer] limit The maximum number of results to return
+        # @option opts [Integer] offset Non-negative integer
+        # @option opts [String] order_by Order results by values of the specified attribute
+        # @option opts [String] sort_order Sort results is ascending or descending order for attribute values specified by order_by
+        # @option opts [Integer] include_release_dates_with_no_data Determines whether release dates with no data available are returned.
+        # @return [Hashie::Mash] Hash containing the results
+        def releases_dates opts={}
+          get "fred/releases/dates", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/fredapi/client/series.rb

@@ -0,0 +1,37 @@
+require 'fredapi/client/series/categories'
+require 'fredapi/client/series/observations'
+require 'fredapi/client/series/release'
+require 'fredapi/client/series/search'
+require 'fredapi/client/series/tags'
+require 'fredapi/client/series/updates'
+require 'fredapi/client/series/vintage_dates'
+
+module FREDAPI
+  class Client
+    # Series module for fred/series endpoint
+    module Series
+
+      # Get an economic data series
+      #
+      # @param opts [Hash] options hash of parameters
+      # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+      # @option opts [String] file_type A key or file extension that indicates the type of file to send
+      # @option opts [Integer] series_id The id for a series
+      # @option opts [String] realtime_start The start of the real-time period
+      # @option opts [String] realtime_end The end of the real-time period
+      # @return [Hashie::Mash] Hash containing the results
+      def series opts={}
+        get "fred/series", opts
+      end
+
+      include FREDAPI::Client::Series::Categories
+      include FREDAPI::Client::Series::Observations
+      include FREDAPI::Client::Series::Release
+      include FREDAPI::Client::Series::Search
+      include FREDAPI::Client::Series::Tags
+      include FREDAPI::Client::Series::Updates
+      include FREDAPI::Client::Series::VintageDates
+
+    end
+  end
+end

data/lib/fredapi/client/series/categories.rb

@@ -0,0 +1,23 @@
+module FREDAPI
+  class Client
+    module Series
+      # Categories module for fred/series/categories endpoint
+      module Categories
+
+        # Get the categories for an economic data series
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+        # @option opts [String] file_type A key or file extension that indicates the type of file to send
+        # @option opts [Integer] series_id The id for a series
+        # @option opts [String] realtime_start The start of the real-time period
+        # @option opts [String] realtime_end The end of the real-time period
+        # @return [Hashie::Mash] Hash containing the results
+        def series_categories opts={}
+          get "fred/series/categories", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/fredapi/client/series/observations.rb

@@ -0,0 +1,33 @@
+module FREDAPI
+  class Client
+    module Series
+      # Observations module for fred/series/observations endpoint
+      module Observations
+
+        # Get the observations or data values for an economic data series
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+        # @option opts [String] file_type A key or file extension that indicates the type of file to send
+        # @option opts [Integer] series_id The id for a series
+        # @option opts [String] realtime_start The start of the real-time period
+        # @option opts [String] realtime_end The end of the real-time period
+        # @option opts [Integer] limit The maximum number of results to return
+        # @option opts [Integer] offset Non-negative integer
+        # @option opts [String] sort_order Sort results is ascending or descending order for attribute values specified by order_by
+        # @option opts [String] observation_start The start of the observation period
+        # @option opts [String] observation_end The end of the observation period
+        # @option opts [String] units A key that indicates a data value transformation
+        # @option opts [String] frequency An optional parameter that indicates a lower frequency to aggregate values to.
+        # @option opts [String] aggregation_method A key that indicates the aggregation method used for frequency aggregation
+        # @option opts [Integer] output_type An integer that indicates an output type
+        # @option opts [String] vintage_dates A comma separated string of YYYY-MM-DD formatted dates in history
+        # @return [Hashie::Mash] Hash containing the results
+        def series_observations opts={}
+          get "fred/series/observations", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/fredapi/client/series/release.rb

@@ -0,0 +1,23 @@
+module FREDAPI
+  class Client
+    module Series
+      # Release module for fred/series/release endpoint
+      module Release
+
+        # Get the release for an economic data series
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+        # @option opts [String] file_type A key or file extension that indicates the type of file to send
+        # @option opts [Integer] series_id The id for a series
+        # @option opts [String] realtime_start The start of the real-time period
+        # @option opts [String] realtime_end The end of the real-time period
+        # @return [Hashie::Mash] Hash containing the results
+        def series_release opts={}
+          get "fred/series/release", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/fredapi/client/series/search.rb

@@ -0,0 +1,38 @@
+require 'fredapi/client/series/search/tags'
+require 'fredapi/client/series/search/related_tags'
+
+module FREDAPI
+  class Client
+    module Series
+      # Search module for fred/series/search endpoint
+      module Search
+
+        # Get economic data series that match keywords
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+        # @option opts [String] file_type A key or file extension that indicates the type of file to send
+        # @option opts [Integer] series_id The id for a series
+        # @option opts [String] search_text The words to match against economic data series
+        # @option opts [String] search_type Determines the type of search to perform
+        # @option opts [String] realtime_start The start of the real-time period
+        # @option opts [String] realtime_end The end of the real-time period
+        # @option opts [Integer] limit The maximum number of results to return
+        # @option opts [Integer] offset Non-negative integer
+        # @option opts [String] order_by Order results by values of the specified attribute
+        # @option opts [String] sort_order Sort results is ascending or descending order for attribute values specified by order_by
+        # @option opts [String] filter_variable The attribute to filter results by
+        # @option opts [String] filter_value The attribute to filter results by
+        # @option opts [String] tag_names A semicolon delimited list of tags to find related tags for
+        # @return [Hashie::Mash] Hash containing the results
+        def series_search opts={}
+          get "fred/series/search", opts
+        end
+
+        include FREDAPI::Client::Series::Search::Tags
+        include FREDAPI::Client::Series::Search::RelatedTags
+
+      end
+    end
+  end
+end

data/lib/fredapi/client/series/search/related_tags.rb

@@ -0,0 +1,32 @@
+module FREDAPI
+  class Client
+    module Series
+      module Search
+        # RelatedTags module for fred/series/search/related_tags endpoint
+        module RelatedTags
+
+          # Get the related tags for a series search
+          #
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+          # @option opts [String] file_type A key or file extension that indicates the type
+          # @option opts [Integer] series_search_text The words to match against economic data series
+          # @option opts [String] realtime_start The start of the real-time period
+          # @option opts [String] realtime_end The end of the real-time period
+          # @option opts [String] tag_group_id A tag group id to filter tags by type
+          # @option opts [String] tag_names A semicolon delimited list of tags to find related tags for
+          # @option opts [String] tag_search_text The words to find matching tags with
+          # @option opts [Integer] limit The maximum number of results to return
+          # @option opts [Integer] offset Non-negative integer
+          # @option opts [String] order_by Order results by values of the specified attribute
+          # @option opts [String] sort_order Sort results is ascending or descending order for attribute values specified by order_by
+          # @return [Hashie::Mash] Hash containing the results
+          def series_search_related_tags opts={}
+            get "fred/series/search/related_tags", opts
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/fredapi/client/series/search/tags.rb

@@ -0,0 +1,32 @@
+module FREDAPI
+  class Client
+    module Series
+      module Search
+        # Tags module for fred/series/search/tags endpoint
+        module Tags
+
+          # Get the tags for a series search
+          #
+          # @param opts [Hash] options hash of parameters
+          # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+          # @option opts [String] file_type A key or file extension that indicates the type
+          # @option opts [Integer] series_search_text The words to match against economic data series
+          # @option opts [String] realtime_start The start of the real-time period
+          # @option opts [String] realtime_end The end of the real-time period
+          # @option opts [String] tag_group_id A tag group id to filter tags by type
+          # @option opts [String] tag_names A semicolon delimited list of tags to find related tags for
+          # @option opts [String] tag_search_text The words to find matching tags with
+          # @option opts [Integer] limit The maximum number of results to return
+          # @option opts [Integer] offset Non-negative integer
+          # @option opts [String] order_by Order results by values of the specified attribute
+          # @option opts [String] sort_order Sort results is ascending or descending order for attribute values specified by order_by
+          # @return [Hashie::Mash] Hash containing the results
+          def series_search_tags opts={}
+            get "fred/series/search/tags", opts
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/fredapi/client/series/tags.rb

@@ -0,0 +1,25 @@
+module FREDAPI
+  class Client
+    module Series
+      # Tags module for fred/series/tags endpoint
+      module Tags
+
+        # Get the tags for an economic data series
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+        # @option opts [String] file_type A key or file extension that indicates the type of file to send
+        # @option opts [Integer] series_id The id for a series
+        # @option opts [String] realtime_start The start of the real-time period
+        # @option opts [String] realtime_end The end of the real-time period
+        # @option opts [String] order_by Order results by values of the specified attribute
+        # @option opts [String] sort_order Sort results is ascending or descending order for attribute values specified by order_by
+        # @return [Hashie::Mash] Hash containing the results
+        def series_tags opts={}
+          get "fred/series/tags", opts
+        end
+
+      end
+    end
+  end
+end

data/lib/fredapi/client/series/updates.rb

@@ -0,0 +1,26 @@
+module FREDAPI
+  class Client
+    module Series
+      # Updates module for fred/series/updates endpoint
+      module Updates
+
+        # Get economic data series sorted by when observations
+        # were updated on the FRED® server
+        #
+        # @param opts [Hash] options hash of parameters
+        # @option opts [Integer] api_key 32 character alpha-numeric lowercase string
+        # @option opts [String] file_type A key or file extension that indicates the type of file to send
+        # @option opts [String] realtime_start The start of the real-time period
+        # @option opts [String] realtime_end The end of the real-time period
+        # @option opts [Integer] limit The maximum number of results to return
+        # @option opts [Integer] offset Non-negative integer
+        # @option opts [String] filter_value The attribute to filter results by
+        # @return [Hashie::Mash] Hash containing the results
+        def series_updates opts={}
+          get "fred/series/updates", opts
+        end
+
+      end
+    end
+  end
+end