brapi-ruby-sdk 0.1.0 → 0.3.0

data/lib/brapi/models/summary_profile.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    class SummaryProfile < Brapi::Model
+      attribute :address1, type: :string
+      attribute :address2, type: :string
+      attribute :address3, type: :string
+      attribute :city, type: :string
+      attribute :state, type: :string
+      attribute :zip, type: :string
+      attribute :country, type: :string
+      attribute :phone, type: :string
+      attribute :fax, type: :string
+      attribute :website, type: :string
+      attribute :industry, type: :string
+      attribute :industry_key, type: :string
+      attribute :industry_disp, type: :string
+      attribute :sector, type: :string
+      attribute :sector_key, type: :string
+      attribute :sector_disp, type: :string
+      attribute :long_business_summary, type: :string
+      attribute :full_time_employees, type: :integer
+      attribute :company_officers
+      attribute :twitter, type: :string
+      attribute :name, type: :string
+      attribute :start_date, type: :string
+      attribute :description, type: :string
+      attribute :logo_url, type: :string
+      attribute :cnpj, type: :string
+
+      attribute :administrator_name, type: :string
+      attribute :administrator_cnpj, type: :string
+      attribute :administrator_address, type: :string
+      attribute :administrator_address_number, type: :string
+      attribute :administrator_address_complement, type: :string
+      attribute :administrator_district, type: :string
+      attribute :administrator_city, type: :string
+      attribute :administrator_state, type: :string
+      attribute :administrator_zip_code, type: :string
+      attribute :administrator_phone1, type: :string
+      attribute :administrator_phone2, type: :string
+      attribute :administrator_phone3, type: :string
+      attribute :administrator_website, type: :string
+      attribute :administrator_email, type: :string
+    end
+  end
+end

data/lib/brapi/models/v2/fii.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      # Single class backing both /api/v2/fii/list (basic info) and
+      # /api/v2/fii/indicators (basic info + current indicators).
+      # Indicator-only fields come back nil from the list endpoint.
+      class Fii < Brapi::Model
+        attribute :symbol, type: :string
+        attribute :name, type: :string
+        attribute :cnpj, type: :string
+        attribute :mandate, type: :string
+        # NOTE: brapi exposes these two fields in Portuguese (`segmentoAtuacao`,
+        # `tipoGestao`); everything else in the response uses English. If the
+        # upstream renames them in a future API revision, callers reading
+        # `#segmento_atuacao` / `#tipo_gestao` will silently get nil and need
+        # the attribute names updated here.
+        attribute :segmento_atuacao, type: :string
+        attribute :tipo_gestao, type: :string
+        attribute :segment_type, type: :string
+
+        attribute :administrator_name, type: :string
+        attribute :administrator_cnpj, type: :string
+        attribute :administrator_address, type: :string
+        attribute :administrator_address_number, type: :string
+        attribute :administrator_address_complement, type: :string
+        attribute :administrator_district, type: :string
+        attribute :administrator_city, type: :string
+        attribute :administrator_state, type: :string
+        attribute :administrator_zip_code, type: :string
+        attribute :administrator_phone1, type: :string
+        attribute :administrator_phone2, type: :string
+        attribute :administrator_phone3, type: :string
+        attribute :administrator_website, type: :string
+        attribute :administrator_email, type: :string
+
+        attribute :price, type: :float
+        attribute :nav_per_share, type: :float
+        attribute :price_to_nav, type: :float
+        attribute :dividend_yield12m, type: :float, json_key: "dividendYield12m"
+        attribute :total_investors, type: :integer
+
+        # Indicators-only fields (nil when returned by /fii/list)
+        attribute :as_of_date, type: :date
+        attribute :dividend_yield1m, type: :float, json_key: "dividendYield1m"
+        attribute :monthly_return, type: :float
+        attribute :shares_outstanding, type: :integer
+        attribute :equity
+        attribute :total_assets
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/fii_dividend.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class FiiDividend < Brapi::Model
+        attribute :symbol, type: :string
+        attribute :label, type: :string
+        attribute :rate, type: :float
+        attribute :related_to, type: :string
+        attribute :approved_on, type: :time
+        attribute :last_date_prior, type: :time
+        attribute :payment_date, type: :time
+        attribute :isin_code, type: :string
+        attribute :remarks, type: :string
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/fii_dividends_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class FiiDividendsResponse < Brapi::Model
+        attribute :dividends, type: [Brapi::Models::V2::FiiDividend]
+        attribute :requested_at, type: :time
+        attribute :took, type: :integer
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/fii_historical_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class FiiHistoricalResponse < Brapi::Model
+        attribute :fiis, type: [Brapi::Models::V2::FiiHistory]
+        attribute :requested_at, type: :time
+        attribute :took, type: :integer
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/fii_history.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      # Wraps a single FII's historical price series. The historical_data_price
+      # entries reuse Brapi::Models::HistoricalDataPrice (same OHLCV shape as
+      # /api/quote/{ticker}?range=...).
+      class FiiHistory < Brapi::Model
+        attribute :symbol, type: :string
+        attribute :historical_data_price, type: [Brapi::Models::HistoricalDataPrice]
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/fii_indicators_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class FiiIndicatorsResponse < Brapi::Model
+        attribute :fiis, type: [Brapi::Models::V2::Fii]
+        attribute :requested_at, type: :time
+        attribute :took, type: :integer
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/fii_list_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class FiiListResponse < Brapi::Model
+        attribute :fiis, type: [Brapi::Models::V2::Fii]
+        attribute :pagination, type: Brapi::Models::Pagination
+        attribute :requested_at, type: :time
+        attribute :took, type: :integer
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/macro_list_available_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class MacroListAvailableResponse < Brapi::Model
+        attribute :results, type: [Brapi::Models::V2::MacroSeries]
+        attribute :categories
+        attribute :count, type: :integer
+        attribute :requested_at, type: :time
+        attribute :took, type: :integer
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/macro_observation.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class MacroObservation < Brapi::Model
+        attribute :date, type: :date
+        attribute :value, type: :float
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/macro_result.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      # One result entry from /api/v2/macro: a MacroSeries description plus
+      # the observation rows (date + value) for that series.
+      class MacroResult < Brapi::Model
+        attribute :series, type: Brapi::Models::V2::MacroSeries
+        attribute :observations, type: [Brapi::Models::V2::MacroObservation]
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/macro_retrieve_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class MacroRetrieveResponse < Brapi::Model
+        attribute :results, type: [Brapi::Models::V2::MacroResult]
+        attribute :requested_at, type: :time
+        attribute :took, type: :integer
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/macro_series.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class MacroSeries < Brapi::Model
+        attribute :slug, type: :string
+        attribute :name, type: :string
+        attribute :description, type: :string
+        attribute :unit, type: :string
+        attribute :frequency, type: :string
+        attribute :category, type: :string
+        attribute :start_date, type: :date
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/treasury_bond.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      # Single Tesouro Direto bond as returned by /api/v2/treasury/list and
+      # /api/v2/treasury/indicators (both endpoints share the same shape).
+      #
+      # buyRate / sellRate semantics depend on the bond's indexer — see
+      # TreasuryRateInfo#rate_type / #description.
+      class TreasuryBond < Brapi::Model
+        attribute :symbol, type: :string
+        attribute :bond_type, type: :string
+        attribute :indexer, type: :string
+        attribute :coupon_type, type: :string
+        attribute :maturity_date, type: :date
+        attribute :duration_days, type: :integer
+        attribute :base_date, type: :date
+        attribute :buy_rate, type: :float
+        attribute :sell_rate, type: :float
+        attribute :buy_price, type: :float
+        attribute :sell_price, type: :float
+        attribute :base_price, type: :float
+        attribute :rate_info, type: Brapi::Models::V2::TreasuryRateInfo
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/treasury_indicators_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class TreasuryIndicatorsResponse < Brapi::Model
+        attribute :results, type: [Brapi::Models::V2::TreasuryBond]
+        attribute :requested_at, type: :time
+        attribute :took, type: :integer
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/treasury_list_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class TreasuryListResponse < Brapi::Model
+        attribute :results, type: [Brapi::Models::V2::TreasuryBond]
+        attribute :pagination, type: Brapi::Models::Pagination
+        attribute :requested_at, type: :time
+        attribute :took, type: :integer
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/treasury_rate_info.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class TreasuryRateInfo < Brapi::Model
+        attribute :rate_type, type: :string
+        attribute :rate_unit, type: :string
+        attribute :description, type: :string
+      end
+    end
+  end
+end

data/lib/brapi/models/value_added_entry.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    # Demonstração do Valor Adicionado (DVA).
+    class ValueAddedEntry < Brapi::Model
+      attribute :type, type: :string
+      attribute :end_date, type: :string
+      attribute :revenue
+      attribute :product_sales
+      attribute :other_revenues
+      attribute :construction_of_own_assets
+      attribute :provision_or_reversal_of_doubtful_accounts
+      attribute :supplies_purchased_from_third_parties
+      attribute :costs_with_products_sold
+      attribute :third_party_materials_and_services
+      attribute :loss_or_recovery_of_assets
+      attribute :other_supplies
+      attribute :gross_added_value
+      attribute :retentions
+      attribute :depreciation_and_amortization
+      attribute :other_retentions
+      attribute :net_added_value
+      attribute :net_added_value_produced
+      attribute :added_value_received_on_transfer
+      attribute :added_value_received_by_transfer
+      attribute :equity_income_result
+      attribute :financial_income
+      attribute :other_values_received_on_transfer
+      attribute :other_values_received_by_transfer
+      attribute :added_value_to_distribute
+      attribute :total_added_value_to_distribute
+      attribute :distribution_of_added_value
+      attribute :team_remuneration
+      attribute :taxes
+      attribute :federal_taxes
+      attribute :state_taxes
+      attribute :municipal_taxes
+      attribute :remuneration_of_third_party_capitals
+      attribute :equity_remuneration
+      attribute :own_equity_remuneration
+      attribute :interest_on_own_equity
+      attribute :dividends
+      attribute :retained_earnings_or_loss
+      attribute :non_controlling_share_of_retained_earnings
+      attribute :other_distributions
+      attribute :financial_intermediation_revenue
+      attribute :revenue_from_the_provision_of_services
+      attribute :provision_or_reversal_of_expected_credit_risk_losses
+      attribute :financial_intermediation_expenses
+      attribute :materials_energy_and_others
+      attribute :services
+      attribute :loss_or_recovery_of_asset_values
+      attribute :third_party_equity_remuneration
+      attribute :insurance_operations_revenue
+      attribute :complementary_pension_operations_revenue
+      attribute :fees_revenue
+      attribute :variations_of_technical_provisions
+      attribute :insurance_operations_variations
+      attribute :pension_operations_variations
+      attribute :other_variations
+      attribute :net_operating_revenue
+      attribute :claims_and_benefits
+      attribute :variation_in_deferred_selling_expenses
+      attribute :results_of_ceded_reinsurance_operations
+      attribute :result_of_coinsurance_operations_assigned
+    end
+  end
+end

data/lib/brapi/resource.rb

@@ -14,6 +14,13 @@ module Brapi
       client.request(:get, path, params: camelize_keys(params))
     end
 
+    # Brapi endpoints that accept a `symbols` query param take a comma-separated
+    # list. Accepts a single String, a single Symbol, or any Enumerable of the
+    # two; always returns a String.
+    def format_symbols(symbols)
+      Array(symbols).join(",")
+    end
+
     def camelize_keys(params)
       return params if params.nil? || params.empty?
 

data/lib/brapi/resources/v2/fii.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Resources
+    class V2
+      class Fii < Brapi::Resource
+        # GET /api/v2/fii/list
+        def list(**params)
+          raw = get("/api/v2/fii/list", params: params)
+          Brapi::Models::V2::FiiListResponse.from_h(raw)
+        end
+
+        # GET /api/v2/fii/indicators?symbols=...
+        def indicators(symbols, **params)
+          raw = get("/api/v2/fii/indicators", params: params.merge(symbols: format_symbols(symbols)))
+          Brapi::Models::V2::FiiIndicatorsResponse.from_h(raw)
+        end
+
+        # GET /api/v2/fii/historical?symbols=...
+        def historical(symbols, **params)
+          raw = get("/api/v2/fii/historical", params: params.merge(symbols: format_symbols(symbols)))
+          Brapi::Models::V2::FiiHistoricalResponse.from_h(raw)
+        end
+
+        # GET /api/v2/fii/dividends?symbols=...
+        def dividends(symbols, **params)
+          raw = get("/api/v2/fii/dividends", params: params.merge(symbols: format_symbols(symbols)))
+          Brapi::Models::V2::FiiDividendsResponse.from_h(raw)
+        end
+      end
+    end
+  end
+end

data/lib/brapi/resources/v2/macro.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Resources
+    class V2
+      class Macro < Brapi::Resource
+        # GET /api/v2/macro?symbols=...
+        def retrieve(symbols, **params)
+          raw = get("/api/v2/macro", params: params.merge(symbols: format_symbols(symbols)))
+          Brapi::Models::V2::MacroRetrieveResponse.from_h(raw)
+        end
+
+        # GET /api/v2/macro/available
+        def list_available
+          raw = get("/api/v2/macro/available")
+          Brapi::Models::V2::MacroListAvailableResponse.from_h(raw)
+        end
+      end
+    end
+  end
+end

data/lib/brapi/resources/v2/treasury.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Resources
+    class V2
+      class Treasury < Brapi::Resource
+        # GET /api/v2/treasury/list
+        def list(**params)
+          raw = get("/api/v2/treasury/list", params: params)
+          Brapi::Models::V2::TreasuryListResponse.from_h(raw)
+        end
+
+        # GET /api/v2/treasury/indicators?symbols=...
+        def indicators(symbols, **params)
+          raw = get("/api/v2/treasury/indicators", params: params.merge(symbols: format_symbols(symbols)))
+          Brapi::Models::V2::TreasuryIndicatorsResponse.from_h(raw)
+        end
+      end
+    end
+  end
+end

data/lib/brapi/resources/v2.rb

@@ -24,6 +24,18 @@ module Brapi
       def prime_rate
         @prime_rate ||= Brapi::Resources::V2::PrimeRate.new(client)
       end
+
+      def fii
+        @fii ||= Brapi::Resources::V2::Fii.new(client)
+      end
+
+      def macro
+        @macro ||= Brapi::Resources::V2::Macro.new(client)
+      end
+
+      def treasury
+        @treasury ||= Brapi::Resources::V2::Treasury.new(client)
+      end
     end
   end
 end

data/lib/brapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Brapi
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/brapi.rb

@@ -6,9 +6,20 @@ require "brapi/errors"
 require "brapi/model"
 require "brapi/resource"
 
-# Models — order matters: leaf classes before composite ones.
+# Models — leaf classes first, composite classes after.
 require "brapi/models/balance_sheet_entry"
 require "brapi/models/financial_data_entry"
+require "brapi/models/income_statement_entry"
+require "brapi/models/cashflow_entry"
+require "brapi/models/value_added_entry"
+require "brapi/models/key_statistics_entry"
+require "brapi/models/summary_profile"
+require "brapi/models/historical_data_price"
+require "brapi/models/cash_dividend"
+require "brapi/models/stock_dividend"
+require "brapi/models/subscription"
+require "brapi/models/dividends_data"
+
 require "brapi/models/quote"
 require "brapi/models/quote_retrieve_response"
 require "brapi/models/quote_list_item"
@@ -31,6 +42,27 @@ require "brapi/models/v2/prime_rate_entry"
 require "brapi/models/v2/prime_rate_retrieve_response"
 require "brapi/models/v2/prime_rate_list_available_response"
 
+require "brapi/models/pagination"
+
+require "brapi/models/v2/fii"
+require "brapi/models/v2/fii_dividend"
+require "brapi/models/v2/fii_history"
+require "brapi/models/v2/fii_list_response"
+require "brapi/models/v2/fii_indicators_response"
+require "brapi/models/v2/fii_historical_response"
+require "brapi/models/v2/fii_dividends_response"
+
+require "brapi/models/v2/macro_series"
+require "brapi/models/v2/macro_observation"
+require "brapi/models/v2/macro_result"
+require "brapi/models/v2/macro_retrieve_response"
+require "brapi/models/v2/macro_list_available_response"
+
+require "brapi/models/v2/treasury_rate_info"
+require "brapi/models/v2/treasury_bond"
+require "brapi/models/v2/treasury_list_response"
+require "brapi/models/v2/treasury_indicators_response"
+
 # Resources — v2 (parent class) must load before its nested classes
 require "brapi/resources/quote"
 require "brapi/resources/available"
@@ -39,6 +71,9 @@ require "brapi/resources/v2/crypto"
 require "brapi/resources/v2/currency"
 require "brapi/resources/v2/inflation"
 require "brapi/resources/v2/prime_rate"
+require "brapi/resources/v2/fii"
+require "brapi/resources/v2/macro"
+require "brapi/resources/v2/treasury"
 
 require "brapi/client"