Class: HubSpotSDK::Models::Crm::PublicCrmSearchRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/hubspot_sdk/models/crm/public_crm_search_request.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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(filter_groups:, filters:, sorts:, query: nil) ⇒ Object

Parameters:




# File 'lib/hubspot_sdk/models/crm/public_crm_search_request.rb', line 31

Instance Attribute Details

#filter_groups ⇒ Array<HubSpotSDK::Models::Crm::FilterGroup>

Returns:



10
11
12
 
# File 'lib/hubspot_sdk/models/crm/public_crm_search_request.rb', line 10

required :filter_groups,
-> { HubSpotSDK::Internal::Type::ArrayOf[HubSpotSDK::Crm::FilterGroup] },
api_name: :filterGroups

#filters ⇒ Array<HubSpotSDK::Models::Crm::Filter>

Returns:



17
 
# File 'lib/hubspot_sdk/models/crm/public_crm_search_request.rb', line 17

required :filters, -> { HubSpotSDK::Internal::Type::ArrayOf[HubSpotSDK::Crm::Filter] }

#query ⇒ String?

The search query string, to filter CRM records.

Returns:

  • (String, nil) 


29
 
# File 'lib/hubspot_sdk/models/crm/public_crm_search_request.rb', line 29

optional :query, String

#sorts ⇒ Array<String>

Defines the order in which the CRM records should be returned.

Returns:

  • (Array<String>) 


23
 
# File 'lib/hubspot_sdk/models/crm/public_crm_search_request.rb', line 23

required :sorts, HubSpotSDK::Internal::Type::ArrayOf[String]