Class: HubSpotSDK::Models::Cms::IndexedData

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• HubSpotSDK::Models::Cms::IndexedData

Defined in:

lib/hubspot_sdk/models/cms/indexed_data.rb

Overview

See Also:

• Resources::Cms::SiteSearch#get_indexed_data

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #fields ⇒ Hash{Symbol=>HubSpotSDK::Models::Cms::IndexedField}

  The indexed fields in HubSpot.

• #id ⇒ String

  The ID of the document in HubSpot.

• #type ⇒ Symbol, HubSpotSDK::Models::Cms::IndexedData::Type

  The type of document.

Instance Method Summary

• #initialize(id:, fields:, type:) ⇒ Object constructor

  Some parameter documentations has been truncated, see IndexedData for more details.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, fields:, type:) ⇒ Object

Some parameter documentations has been truncated, see HubSpotSDK::Models::Cms::IndexedData for more details.

‘LISTING_

Parameters:

• id (String) —

  The ID of the document in HubSpot.

• fields (Hash{Symbol=>HubSpotSDK::Models::Cms::IndexedField}) —

  The indexed fields in HubSpot.

• type (Symbol, HubSpotSDK::Models::Cms::IndexedData::Type) —

  The type of document. Can be ‘SITE_PAGE`, `LANDING_PAGE`, `BLOG_POST`,

# File 'lib/hubspot_sdk/models/cms/indexed_data.rb', line 27

Instance Attribute Details

#fields ⇒ Hash{Symbol=>HubSpotSDK::Models::Cms::IndexedField}

The indexed fields in HubSpot.

Returns:

• (Hash{Symbol=>HubSpotSDK::Models::Cms::IndexedField})

# File 'lib/hubspot_sdk/models/cms/indexed_data.rb', line 18

required :fields, -> { HubSpotSDK::Internal::Type::HashOf[HubSpotSDK::Cms::IndexedField] }

#id ⇒ String

The ID of the document in HubSpot.

Returns:

• (String)

# File 'lib/hubspot_sdk/models/cms/indexed_data.rb', line 12

required :id, String

#type ⇒ Symbol, HubSpotSDK::Models::Cms::IndexedData::Type

The type of document. Can be ‘SITE_PAGE`, `LANDING_PAGE`, `BLOG_POST`, `LISTING_PAGE`, or `KNOWLEDGE_ARTICLE`.

Returns:

• (Symbol, HubSpotSDK::Models::Cms::IndexedData::Type)

# File 'lib/hubspot_sdk/models/cms/indexed_data.rb', line 25

required :type, enum: -> { HubSpotSDK::Cms::IndexedData::Type }