Class: HubSpotSDK::Models::Crm::PublicObjectSearchRequest

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• HubSpotSDK::Models::Crm::PublicObjectSearchRequest

Defined in:

lib/hubspot_sdk/models/crm/public_object_search_request.rb

Direct Known Subclasses

AssociationSearchParams, Objects::CallSearchParams, Objects::CartSearchParams, Objects::CommercePaymentSearchParams, Objects::CommunicationSearchParams, Objects::CompanySearchParams, Objects::ContactSearchParams, Objects::ContractSearchParams, Objects::CourseSearchParams, Objects::CustomSearchParams, Objects::DealSearchParams, Objects::DiscountSearchParams, Objects::EmailSearchParams, Objects::FeeSearchParams, Objects::FeedbackSubmissionSearchParams, Objects::GenericObjectSearchParams, Objects::GoalTargetSearchParams, Objects::InvoiceSearchParams, Objects::LeadSearchParams, Objects::LineItemSearchParams, Objects::ListingSearchParams, Objects::MeetingSearchParams, Objects::NoteSearchParams, Objects::OrderSearchParams, Objects::PartnerClientSearchParams, Objects::PartnerServiceSearchParams, Objects::PostalMailSearchParams, Objects::ProductSearchParams, Objects::ProjectSearchParams, Objects::QuoteSearchParams, Objects::ServiceSearchParams, Objects::SubscriptionSearchParams, Objects::TaskSearchParams, Objects::TaxSearchParams, Objects::TicketSearchParams, Objects::UserSearchParams

Instance Attribute Summary

• #after ⇒ String

  A paging cursor token for retrieving subsequent pages.

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

  Up to 6 groups of filters defining additional query criteria.

• #limit ⇒ Integer

  The maximum results to return, up to 200 objects.

• #properties ⇒ Array<String>

  A list of property names to include in the response.

• #query ⇒ String^?

  The search query string, up to 3000 characters.

• #sorts ⇒ Array<String>

  Specifies sorting order based on object properties.

Instance Method Summary

• #initialize(after:, filter_groups:, limit:, properties:, sorts:, query: nil) ⇒ Object constructor

  Describes a search request.

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

Describes a search request

Parameters:

• after (String) —

  A paging cursor token for retrieving subsequent pages.

• filter_groups (Array<HubSpotSDK::Models::Crm::FilterGroup>) —

  Up to 6 groups of filters defining additional query criteria.

• limit (Integer) —

  The maximum results to return, up to 200 objects.

• properties (Array<String>) —

  A list of property names to include in the response.

• sorts (Array<String>) —

  Specifies sorting order based on object properties.

• query (String) (defaults to: nil) —

  The search query string, up to 3000 characters.

# File 'lib/hubspot_sdk/models/crm/public_object_search_request.rb', line 45

Instance Attribute Details

#after ⇒ String

A paging cursor token for retrieving subsequent pages.

Returns:

• (String)

# File 'lib/hubspot_sdk/models/crm/public_object_search_request.rb', line 11

required :after, String

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

Up to 6 groups of filters defining additional query criteria.

Returns:

• (Array<HubSpotSDK::Models::Crm::FilterGroup>)

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

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

#limit ⇒ Integer

The maximum results to return, up to 200 objects.

Returns:

• (Integer)

# File 'lib/hubspot_sdk/models/crm/public_object_search_request.rb', line 25

required :limit, Integer

#properties ⇒ Array<String>

A list of property names to include in the response.

Returns:

• (Array<String>)

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

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

#query ⇒ String^?

The search query string, up to 3000 characters.

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/crm/public_object_search_request.rb', line 43

optional :query, String

#sorts ⇒ Array<String>

Specifies sorting order based on object properties.

Returns:

• (Array<String>)

# File 'lib/hubspot_sdk/models/crm/public_object_search_request.rb', line 37

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