context.dev 2.9.0 → 2.11.0

data/lib/context_dev/models/news_search_response.rb

@@ -0,0 +1,284 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    # @see ContextDev::Resources::News#search
+    class NewsSearchResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute data
+      #   Articles matching the search, in the requested order.
+      #
+      #   @return [Array<ContextDev::Models::NewsSearchResponse::Data>]
+      required :data, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::NewsSearchResponse::Data] }
+
+      # @!attribute has_more
+      #   True when more results are available beyond this page.
+      #
+      #   @return [Boolean]
+      required :has_more, ContextDev::Internal::Type::Boolean
+
+      # @!attribute meta
+      #   Summary information about this response.
+      #
+      #   @return [ContextDev::Models::NewsSearchResponse::Meta]
+      required :meta, -> { ContextDev::Models::NewsSearchResponse::Meta }
+
+      # @!attribute next_cursor
+      #   Pass as cursor in the next request to fetch the following page. Null when there
+      #   are no more results.
+      #
+      #   @return [String, nil]
+      required :next_cursor, String, nil?: true
+
+      # @!attribute key_metadata
+      #   Metadata about the API key used for the request. Included in every response
+      #   whenever a valid API key is provided, even when the response status is not 200.
+      #
+      #   @return [ContextDev::Models::NewsSearchResponse::KeyMetadata, nil]
+      optional :key_metadata, -> { ContextDev::Models::NewsSearchResponse::KeyMetadata }
+
+      # @!method initialize(data:, has_more:, meta:, next_cursor:, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::NewsSearchResponse} for more details.
+      #
+      #   @param data [Array<ContextDev::Models::NewsSearchResponse::Data>] Articles matching the search, in the requested order.
+      #
+      #   @param has_more [Boolean] True when more results are available beyond this page.
+      #
+      #   @param meta [ContextDev::Models::NewsSearchResponse::Meta] Summary information about this response.
+      #
+      #   @param next_cursor [String, nil] Pass as cursor in the next request to fetch the following page. Null when there
+      #
+      #   @param key_metadata [ContextDev::Models::NewsSearchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+
+      class Data < ContextDev::Internal::Type::BaseModel
+        # @!attribute id
+        #   Stable unique identifier for this article. Use it to deduplicate or reference an
+        #   article across requests.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute authors
+        #   Bylined authors. Empty when no byline is available.
+        #
+        #   @return [Array<String>]
+        required :authors, ContextDev::Internal::Type::ArrayOf[String]
+
+        # @!attribute description
+        #   Short summary or excerpt of the article, when the publisher provides one.
+        #
+        #   @return [String, nil]
+        required :description, String, nil?: true
+
+        # @!attribute image_url
+        #   Lead image for the article, when one is available.
+        #
+        #   @return [String, nil]
+        required :image_url, String, nil?: true
+
+        # @!attribute language
+        #   Language the article is written in, as a lowercase ISO 639-1 code such as en.
+        #   Null when unknown.
+        #
+        #   @return [String, nil]
+        required :language, String, nil?: true
+
+        # @!attribute match
+        #   How the article relates to the company you searched for.
+        #
+        #   @return [ContextDev::Models::NewsSearchResponse::Data::Match]
+        required :match, -> { ContextDev::Models::NewsSearchResponse::Data::Match }
+
+        # @!attribute published_at
+        #   When the article was published, as an ISO 8601 timestamp. Null when the
+        #   publisher does not state a reliable date.
+        #
+        #   @return [Time, nil]
+        required :published_at, Time, nil?: true
+
+        # @!attribute source
+        #   The publication that published the article.
+        #
+        #   @return [ContextDev::Models::NewsSearchResponse::Data::Source]
+        required :source, -> { ContextDev::Models::NewsSearchResponse::Data::Source }
+
+        # @!attribute story_id
+        #   Shared by articles covering the same story on the same day. Use it to group or
+        #   collapse syndicated copies of one announcement across outlets.
+        #
+        #   @return [String]
+        required :story_id, String
+
+        # @!attribute title
+        #   Article headline.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!attribute type
+        #   Kind of coverage. Use it to separate independent reporting (editorial) from
+        #   company-issued content (press_release, regulatory_filing, advisory).
+        #
+        #   @return [Symbol, ContextDev::Models::NewsSearchResponse::Data::Type]
+        required :type, enum: -> { ContextDev::Models::NewsSearchResponse::Data::Type }
+
+        # @!attribute url
+        #   Link to the article on the publisher site.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(id:, authors:, description:, image_url:, language:, match:, published_at:, source:, story_id:, title:, type:, url:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::NewsSearchResponse::Data} for more details.
+        #
+        #   @param id [String] Stable unique identifier for this article. Use it to deduplicate or reference an
+        #
+        #   @param authors [Array<String>] Bylined authors. Empty when no byline is available.
+        #
+        #   @param description [String, nil] Short summary or excerpt of the article, when the publisher provides one.
+        #
+        #   @param image_url [String, nil] Lead image for the article, when one is available.
+        #
+        #   @param language [String, nil] Language the article is written in, as a lowercase ISO 639-1 code such as en. Nu
+        #
+        #   @param match [ContextDev::Models::NewsSearchResponse::Data::Match] How the article relates to the company you searched for.
+        #
+        #   @param published_at [Time, nil] When the article was published, as an ISO 8601 timestamp. Null when the publishe
+        #
+        #   @param source [ContextDev::Models::NewsSearchResponse::Data::Source] The publication that published the article.
+        #
+        #   @param story_id [String] Shared by articles covering the same story on the same day. Use it to group or c
+        #
+        #   @param title [String] Article headline.
+        #
+        #   @param type [Symbol, ContextDev::Models::NewsSearchResponse::Data::Type] Kind of coverage. Use it to separate independent reporting (editorial) from comp
+        #
+        #   @param url [String] Link to the article on the publisher site.
+
+        # @see ContextDev::Models::NewsSearchResponse::Data#match
+        class Match < ContextDev::Internal::Type::BaseModel
+          # @!attribute confidence
+          #   How confident the match is, from 0 to 1. Null when a score is unavailable.
+          #
+          #   @return [Float, nil]
+          required :confidence, Float, nil?: true
+
+          # @!attribute level
+          #   primary when the article is mainly about the company, secondary when the company
+          #   is mentioned but is not the main subject.
+          #
+          #   @return [Symbol, ContextDev::Models::NewsSearchResponse::Data::Match::Level]
+          required :level, enum: -> { ContextDev::Models::NewsSearchResponse::Data::Match::Level }
+
+          # @!method initialize(confidence:, level:)
+          #   Some parameter documentations has been truncated, see
+          #   {ContextDev::Models::NewsSearchResponse::Data::Match} for more details.
+          #
+          #   How the article relates to the company you searched for.
+          #
+          #   @param confidence [Float, nil] How confident the match is, from 0 to 1. Null when a score is unavailable.
+          #
+          #   @param level [Symbol, ContextDev::Models::NewsSearchResponse::Data::Match::Level] primary when the article is mainly about the company, secondary when the company
+
+          # primary when the article is mainly about the company, secondary when the company
+          # is mentioned but is not the main subject.
+          #
+          # @see ContextDev::Models::NewsSearchResponse::Data::Match#level
+          module Level
+            extend ContextDev::Internal::Type::Enum
+
+            PRIMARY = :primary
+            SECONDARY = :secondary
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see ContextDev::Models::NewsSearchResponse::Data#source
+        class Source < ContextDev::Internal::Type::BaseModel
+          # @!attribute direct
+          #   True when Context observed this article in the publisher-owned feed.
+          #
+          #   @return [Boolean]
+          required :direct, ContextDev::Internal::Type::Boolean
+
+          # @!attribute domain
+          #   Website domain of the publication.
+          #
+          #   @return [String]
+          required :domain, String
+
+          # @!attribute name
+          #   Name of the publication, such as Reuters.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(direct:, domain:, name:)
+          #   The publication that published the article.
+          #
+          #   @param direct [Boolean] True when Context observed this article in the publisher-owned feed.
+          #
+          #   @param domain [String] Website domain of the publication.
+          #
+          #   @param name [String] Name of the publication, such as Reuters.
+        end
+
+        # Kind of coverage. Use it to separate independent reporting (editorial) from
+        # company-issued content (press_release, regulatory_filing, advisory).
+        #
+        # @see ContextDev::Models::NewsSearchResponse::Data#type
+        module Type
+          extend ContextDev::Internal::Type::Enum
+
+          EDITORIAL = :editorial
+          PRESS_RELEASE = :press_release
+          REGULATORY_FILING = :regulatory_filing
+          ADVISORY = :advisory
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see ContextDev::Models::NewsSearchResponse#meta
+      class Meta < ContextDev::Internal::Type::BaseModel
+        # @!attribute count
+        #   Number of articles in this page.
+        #
+        #   @return [Integer]
+        required :count, Integer
+
+        # @!method initialize(count:)
+        #   Summary information about this response.
+        #
+        #   @param count [Integer] Number of articles in this page.
+      end
+
+      # @see ContextDev::Models::NewsSearchResponse#key_metadata
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute credits_consumed
+        #   The number of credits consumed by this request.
+        #
+        #   @return [Integer]
+        required :credits_consumed, Integer
+
+        # @!attribute credits_remaining
+        #   The number of credits remaining for your organization after this request.
+        #
+        #   @return [Integer]
+        required :credits_remaining, Integer
+
+        # @!method initialize(credits_consumed:, credits_remaining:)
+        #   Metadata about the API key used for the request. Included in every response
+        #   whenever a valid API key is provided, even when the response status is not 200.
+        #
+        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #
+        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+      end
+    end
+  end
+end

data/lib/context_dev/models/parse_handle_params.rb

@@ -28,14 +28,14 @@ module ContextDev
       # @!attribute include_images
       #   Include image references in Markdown output
       #
-      #   @return [Boolean, Symbol, ContextDev::Models::ParseHandleParams::IncludeImages, nil]
-      optional :include_images, union: -> { ContextDev::ParseHandleParams::IncludeImages }
+      #   @return [Boolean, nil]
+      optional :include_images, ContextDev::Internal::Type::Boolean
 
       # @!attribute include_links
       #   Preserve hyperlinks in Markdown output
       #
-      #   @return [Boolean, Symbol, ContextDev::Models::ParseHandleParams::IncludeLinks, nil]
-      optional :include_links, union: -> { ContextDev::ParseHandleParams::IncludeLinks }
+      #   @return [Boolean, nil]
+      optional :include_links, ContextDev::Internal::Type::Boolean
 
       # @!attribute ocr
       #   When true for PDF inputs, OCR the selected pages that have no usable text layer
@@ -44,8 +44,8 @@ module ContextDev
       #   range. Billed at 1 credit per page OCR actually recovered, on top of the base
       #   request cost. When false, no OCR runs.
       #
-      #   @return [Boolean, Symbol, ContextDev::Models::ParseHandleParams::Ocr, nil]
-      optional :ocr, union: -> { ContextDev::ParseHandleParams::Ocr }
+      #   @return [Boolean, nil]
+      optional :ocr, ContextDev::Internal::Type::Boolean
 
       # @!attribute pdf
       #   PDF page-range options as a JSON object, e.g. {"start": 2, "end": 5}.
@@ -56,8 +56,8 @@ module ContextDev
       # @!attribute shorten_base64_images
       #   Shorten base64-encoded image data in the Markdown output
       #
-      #   @return [Boolean, Symbol, ContextDev::Models::ParseHandleParams::ShortenBase64Images, nil]
-      optional :shorten_base64_images, union: -> { ContextDev::ParseHandleParams::ShortenBase64Images }
+      #   @return [Boolean, nil]
+      optional :shorten_base64_images, ContextDev::Internal::Type::Boolean
 
       # @!attribute tags
       #   Optional comma-separated caller-defined tags for tracking this request. Tags are
@@ -70,8 +70,8 @@ module ContextDev
       # @!attribute use_main_content_only
       #   Extract only the main content from HTML-like inputs
       #
-      #   @return [Boolean, Symbol, ContextDev::Models::ParseHandleParams::UseMainContentOnly, nil]
-      optional :use_main_content_only, union: -> { ContextDev::ParseHandleParams::UseMainContentOnly }
+      #   @return [Boolean, nil]
+      optional :use_main_content_only, ContextDev::Internal::Type::Boolean
 
       # @!attribute zdr
       #   Set to enabled to bypass shared caches and omit request and response content
@@ -92,19 +92,19 @@ module ContextDev
       #
       #   @param extension [Symbol, ContextDev::Models::ParseHandleParams::Extension] Optional file extension hint, such as pdf, docx, xlsx, pptx, html, json, csv, md
       #
-      #   @param include_images [Boolean, Symbol, ContextDev::Models::ParseHandleParams::IncludeImages] Include image references in Markdown output
+      #   @param include_images [Boolean] Include image references in Markdown output
       #
-      #   @param include_links [Boolean, Symbol, ContextDev::Models::ParseHandleParams::IncludeLinks] Preserve hyperlinks in Markdown output
+      #   @param include_links [Boolean] Preserve hyperlinks in Markdown output
       #
-      #   @param ocr [Boolean, Symbol, ContextDev::Models::ParseHandleParams::Ocr] When true for PDF inputs, OCR the selected pages that have no usable text layer
+      #   @param ocr [Boolean] When true for PDF inputs, OCR the selected pages that have no usable text layer
       #
       #   @param pdf [ContextDev::Models::ParseHandleParams::Pdf] PDF page-range options as a JSON object, e.g. {"start": 2, "end": 5}.
       #
-      #   @param shorten_base64_images [Boolean, Symbol, ContextDev::Models::ParseHandleParams::ShortenBase64Images] Shorten base64-encoded image data in the Markdown output
+      #   @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
       #
       #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
       #
-      #   @param use_main_content_only [Boolean, Symbol, ContextDev::Models::ParseHandleParams::UseMainContentOnly] Extract only the main content from HTML-like inputs
+      #   @param use_main_content_only [Boolean] Extract only the main content from HTML-like inputs
       #
       #   @param zdr [Symbol, ContextDev::Models::ParseHandleParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
       #
@@ -190,85 +190,6 @@ module ContextDev
         #   @return [Array<Symbol>]
       end
 
-      # Include image references in Markdown output
-      module IncludeImages
-        extend ContextDev::Internal::Type::Union
-
-        variant ContextDev::Internal::Type::Boolean
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::IncludeImages::TRUE }
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::IncludeImages::FALSE }
-
-        # @!method self.variants
-        #   @return [Array(Boolean, Symbol)]
-
-        define_sorbet_constant!(:Variants) do
-          T.type_alias { T.any(T::Boolean, ContextDev::ParseHandleParams::IncludeImages::TaggedSymbol) }
-        end
-
-        # @!group
-
-        TRUE = :true
-        FALSE = :false
-
-        # @!endgroup
-      end
-
-      # Preserve hyperlinks in Markdown output
-      module IncludeLinks
-        extend ContextDev::Internal::Type::Union
-
-        variant ContextDev::Internal::Type::Boolean
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::IncludeLinks::TRUE }
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::IncludeLinks::FALSE }
-
-        # @!method self.variants
-        #   @return [Array(Boolean, Symbol)]
-
-        define_sorbet_constant!(:Variants) do
-          T.type_alias { T.any(T::Boolean, ContextDev::ParseHandleParams::IncludeLinks::TaggedSymbol) }
-        end
-
-        # @!group
-
-        TRUE = :true
-        FALSE = :false
-
-        # @!endgroup
-      end
-
-      # When true for PDF inputs, OCR the selected pages that have no usable text layer
-      # (scans), replacing each recovered page's text with the OCR result while pages
-      # with a real text layer keep it. pdf.start/pdf.end limit the inclusive page
-      # range. Billed at 1 credit per page OCR actually recovered, on top of the base
-      # request cost. When false, no OCR runs.
-      module Ocr
-        extend ContextDev::Internal::Type::Union
-
-        variant ContextDev::Internal::Type::Boolean
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::Ocr::TRUE }
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::Ocr::FALSE }
-
-        # @!method self.variants
-        #   @return [Array(Boolean, Symbol)]
-
-        define_sorbet_constant!(:Variants) do
-          T.type_alias { T.any(T::Boolean, ContextDev::ParseHandleParams::Ocr::TaggedSymbol) }
-        end
-
-        # @!group
-
-        TRUE = :true
-        FALSE = :false
-
-        # @!endgroup
-      end
-
       class Pdf < ContextDev::Internal::Type::BaseModel
         # @!attribute end_
         #   Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
@@ -294,56 +215,6 @@ module ContextDev
         #   @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page.
       end
 
-      # Shorten base64-encoded image data in the Markdown output
-      module ShortenBase64Images
-        extend ContextDev::Internal::Type::Union
-
-        variant ContextDev::Internal::Type::Boolean
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::ShortenBase64Images::TRUE }
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::ShortenBase64Images::FALSE }
-
-        # @!method self.variants
-        #   @return [Array(Boolean, Symbol)]
-
-        define_sorbet_constant!(:Variants) do
-          T.type_alias { T.any(T::Boolean, ContextDev::ParseHandleParams::ShortenBase64Images::TaggedSymbol) }
-        end
-
-        # @!group
-
-        TRUE = :true
-        FALSE = :false
-
-        # @!endgroup
-      end
-
-      # Extract only the main content from HTML-like inputs
-      module UseMainContentOnly
-        extend ContextDev::Internal::Type::Union
-
-        variant ContextDev::Internal::Type::Boolean
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::UseMainContentOnly::TRUE }
-
-        variant const: -> { ContextDev::Models::ParseHandleParams::UseMainContentOnly::FALSE }
-
-        # @!method self.variants
-        #   @return [Array(Boolean, Symbol)]
-
-        define_sorbet_constant!(:Variants) do
-          T.type_alias { T.any(T::Boolean, ContextDev::ParseHandleParams::UseMainContentOnly::TaggedSymbol) }
-        end
-
-        # @!group
-
-        TRUE = :true
-        FALSE = :false
-
-        # @!endgroup
-      end
-
       # Set to enabled to bypass shared caches and omit request and response content
       # from retained usage logs. Requires zero data retention to be enabled for your
       # organization (contact support@context.dev), otherwise the request fails with

data/lib/context_dev/models/person_enrich_response.rb

@@ -64,6 +64,16 @@ module ContextDev
 
           # @see ContextDev::Models::PersonEnrichResponse::Match::Candidate#person
           class Person < ContextDev::Internal::Type::BaseModel
+            # @!attribute current_role_status
+            #   Whether the person's current role is known. `present` — current_role is
+            #   populated. `none` — the work history explicitly shows every role has ended.
+            #   `unknown` — our data sources could not confirm either way; treat a missing
+            #   current_role as unverified rather than vacant.
+            #
+            #   @return [Symbol, ContextDev::Models::PersonEnrichResponse::Match::Candidate::Person::CurrentRoleStatus]
+            required :current_role_status,
+                     enum: -> { ContextDev::Models::PersonEnrichResponse::Match::Candidate::Person::CurrentRoleStatus }
+
             # @!attribute education
             #
             #   @return [Array<ContextDev::Models::PersonEnrichResponse::Match::Candidate::Person::Education>]
@@ -101,6 +111,12 @@ module ContextDev
             #   @return [String, nil]
             optional :bio, String
 
+            # @!attribute checked_at
+            #   When we last refreshed this profile from our data sources (ISO 8601).
+            #
+            #   @return [String, nil]
+            optional :checked_at, String
+
             # @!attribute current_role
             #
             #   @return [ContextDev::Models::PersonEnrichResponse::Match::Candidate::Person::CurrentRole, nil]
@@ -112,6 +128,13 @@ module ContextDev
             #   @return [String, nil]
             optional :email, String
 
+            # @!attribute last_updated
+            #   When the underlying profile data last changed in our data sources (ISO 8601).
+            #   Omitted when unknown.
+            #
+            #   @return [String, nil]
+            optional :last_updated, String
+
             # @!attribute location
             #
             #   @return [ContextDev::Models::PersonEnrichResponse::Match::Candidate::Person::Location, nil]
@@ -122,19 +145,56 @@ module ContextDev
             #   @return [ContextDev::Models::PersonEnrichResponse::Match::Candidate::Person::Name, nil]
             optional :name, -> { ContextDev::Models::PersonEnrichResponse::Match::Candidate::Person::Name }
 
-            # @!method initialize(education:, experience:, skills:, social_urls:, website_urls:, avatar_url: nil, bio: nil, current_role: nil, email: nil, location: nil, name: nil)
+            # @!method initialize(current_role_status:, education:, experience:, skills:, social_urls:, website_urls:, avatar_url: nil, bio: nil, checked_at: nil, current_role: nil, email: nil, last_updated: nil, location: nil, name: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {ContextDev::Models::PersonEnrichResponse::Match::Candidate::Person} for more
+            #   details.
+            #
+            #   @param current_role_status [Symbol, ContextDev::Models::PersonEnrichResponse::Match::Candidate::Person::CurrentRoleStatus] Whether the person's current role is known. `present` — current_role is populate
+            #
             #   @param education [Array<ContextDev::Models::PersonEnrichResponse::Match::Candidate::Person::Education>]
+            #
             #   @param experience [Array<ContextDev::Models::PersonEnrichResponse::Match::Candidate::Person::Experience>]
+            #
             #   @param skills [Array<String>]
+            #
             #   @param social_urls [Array<String>]
+            #
             #   @param website_urls [Array<String>]
+            #
             #   @param avatar_url [String]
+            #
             #   @param bio [String]
+            #
+            #   @param checked_at [String] When we last refreshed this profile from our data sources (ISO 8601).
+            #
             #   @param current_role [ContextDev::Models::PersonEnrichResponse::Match::Candidate::Person::CurrentRole]
+            #
             #   @param email [String]
+            #
+            #   @param last_updated [String] When the underlying profile data last changed in our data sources (ISO 8601). Om
+            #
             #   @param location [ContextDev::Models::PersonEnrichResponse::Match::Candidate::Person::Location]
+            #
             #   @param name [ContextDev::Models::PersonEnrichResponse::Match::Candidate::Person::Name]
 
+            # Whether the person's current role is known. `present` — current_role is
+            # populated. `none` — the work history explicitly shows every role has ended.
+            # `unknown` — our data sources could not confirm either way; treat a missing
+            # current_role as unverified rather than vacant.
+            #
+            # @see ContextDev::Models::PersonEnrichResponse::Match::Candidate::Person#current_role_status
+            module CurrentRoleStatus
+              extend ContextDev::Internal::Type::Enum
+
+              PRESENT = :present
+              NONE = :none
+              UNKNOWN = :unknown
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
             class Education < ContextDev::Internal::Type::BaseModel
               # @!attribute institution
               #