Class: HubSpotSDK::Models::Crm::PublicNumAssociationsFilter

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/hubspot_sdk/models/crm/public_num_associations_filter.rb

Defined Under Namespace

Modules: CoalescingRefineBy, FilterType

Instance Attribute Summary

• #association_category ⇒ String

  Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK).

• #association_type_id ⇒ Integer

  The ID representing the type of association being filtered.

• #coalescing_refine_by ⇒ HubSpotSDK::Models::Crm::PublicNumOccurrencesRefineBy, ...

  Specifies the criteria for refining the association filter.

• #filter_type ⇒ Symbol, HubSpotSDK::Models::Crm::PublicNumAssociationsFilter::FilterType

  Indicates the type of filter being applied (NUM_ASSOCIATIONS).

Class Method Summary

• .variants ⇒ Array(HubSpotSDK::Models::Crm::PublicNumOccurrencesRefineBy, HubSpotSDK::Models::Crm::PublicSetOccurrencesRefineBy, HubSpotSDK::Models::Crm::PublicRelativeComparativeTimestampRefineBy, HubSpotSDK::Models::Crm::PublicRelativeRangedTimestampRefineBy, HubSpotSDK::Models::Crm::PublicAbsoluteComparativeTimestampRefineBy, HubSpotSDK::Models::Crm::PublicAbsoluteRangedTimestampRefineBy, HubSpotSDK::Models::Crm::PublicAllHistoryRefineBy, HubSpotSDK::Models::Crm::PublicTimePointOperation, HubSpotSDK::Models::Crm::PublicRangedTimeOperation)

Instance Method Summary

• #initialize(association_category:, association_type_id:, coalescing_refine_by:, filter_type:) ⇒ Object constructor

  Some parameter documentations has been truncated, see PublicNumAssociationsFilter 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(association_category:, association_type_id:, coalescing_refine_by:, filter_type:) ⇒ Object

Some parameter documentations has been truncated, see HubSpotSDK::Models::Crm::PublicNumAssociationsFilter for more details.

Parameters:

• association_category (String) —

  Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRAT

• association_type_id (Integer) —

  The ID representing the type of association being filtered.

• coalescing_refine_by (HubSpotSDK::Models::Crm::PublicNumOccurrencesRefineBy, HubSpotSDK::Models::Crm::PublicSetOccurrencesRefineBy, HubSpotSDK::Models::Crm::PublicRelativeComparativeTimestampRefineBy, HubSpotSDK::Models::Crm::PublicRelativeRangedTimestampRefineBy, HubSpotSDK::Models::Crm::PublicAbsoluteComparativeTimestampRefineBy, HubSpotSDK::Models::Crm::PublicAbsoluteRangedTimestampRefineBy, HubSpotSDK::Models::Crm::PublicAllHistoryRefineBy, HubSpotSDK::Models::Crm::PublicTimePointOperation, HubSpotSDK::Models::Crm::PublicRangedTimeOperation) —

  Specifies the criteria for refining the association filter.

• filter_type (Symbol, HubSpotSDK::Models::Crm::PublicNumAssociationsFilter::FilterType) —

  Indicates the type of filter being applied (NUM_ASSOCIATIONS).

# File 'lib/hubspot_sdk/models/crm/public_num_associations_filter.rb', line 36

Instance Attribute Details

#association_category ⇒ String

Defines the category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED, WORK).

Returns:

• (String)

# File 'lib/hubspot_sdk/models/crm/public_num_associations_filter.rb', line 12

required :association_category, String, api_name: :associationCategory

#association_type_id ⇒ Integer

The ID representing the type of association being filtered.

Returns:

• (Integer)

# File 'lib/hubspot_sdk/models/crm/public_num_associations_filter.rb', line 18

required :association_type_id, Integer, api_name: :associationTypeId

#coalescing_refine_by ⇒ HubSpotSDK::Models::Crm::PublicNumOccurrencesRefineBy, ...

Specifies the criteria for refining the association filter.

Returns:

• (HubSpotSDK::Models::Crm::PublicNumOccurrencesRefineBy, HubSpotSDK::Models::Crm::PublicSetOccurrencesRefineBy, HubSpotSDK::Models::Crm::PublicRelativeComparativeTimestampRefineBy, HubSpotSDK::Models::Crm::PublicRelativeRangedTimestampRefineBy, HubSpotSDK::Models::Crm::PublicAbsoluteComparativeTimestampRefineBy, HubSpotSDK::Models::Crm::PublicAbsoluteRangedTimestampRefineBy, HubSpotSDK::Models::Crm::PublicAllHistoryRefineBy, HubSpotSDK::Models::Crm::PublicTimePointOperation, HubSpotSDK::Models::Crm::PublicRangedTimeOperation)

# File 'lib/hubspot_sdk/models/crm/public_num_associations_filter.rb', line 24

required :coalescing_refine_by,
union: -> { HubSpotSDK::Crm::PublicNumAssociationsFilter::CoalescingRefineBy },
api_name: :coalescingRefineBy

#filter_type ⇒ Symbol, HubSpotSDK::Models::Crm::PublicNumAssociationsFilter::FilterType

Indicates the type of filter being applied (NUM_ASSOCIATIONS).

Returns:

• (Symbol, HubSpotSDK::Models::Crm::PublicNumAssociationsFilter::FilterType)

# File 'lib/hubspot_sdk/models/crm/public_num_associations_filter.rb', line 32

required :filter_type,
enum: -> { HubSpotSDK::Crm::PublicNumAssociationsFilter::FilterType },
api_name: :filterType

Class Method Details

.variants ⇒ Array(HubSpotSDK::Models::Crm::PublicNumOccurrencesRefineBy, HubSpotSDK::Models::Crm::PublicSetOccurrencesRefineBy, HubSpotSDK::Models::Crm::PublicRelativeComparativeTimestampRefineBy, HubSpotSDK::Models::Crm::PublicRelativeRangedTimestampRefineBy, HubSpotSDK::Models::Crm::PublicAbsoluteComparativeTimestampRefineBy, HubSpotSDK::Models::Crm::PublicAbsoluteRangedTimestampRefineBy, HubSpotSDK::Models::Crm::PublicAllHistoryRefineBy, HubSpotSDK::Models::Crm::PublicTimePointOperation, HubSpotSDK::Models::Crm::PublicRangedTimeOperation)

Returns:

• (Array(HubSpotSDK::Models::Crm::PublicNumOccurrencesRefineBy, HubSpotSDK::Models::Crm::PublicSetOccurrencesRefineBy, HubSpotSDK::Models::Crm::PublicRelativeComparativeTimestampRefineBy, HubSpotSDK::Models::Crm::PublicRelativeRangedTimestampRefineBy, HubSpotSDK::Models::Crm::PublicAbsoluteComparativeTimestampRefineBy, HubSpotSDK::Models::Crm::PublicAbsoluteRangedTimestampRefineBy, HubSpotSDK::Models::Crm::PublicAllHistoryRefineBy, HubSpotSDK::Models::Crm::PublicTimePointOperation, HubSpotSDK::Models::Crm::PublicRangedTimeOperation))

# File 'lib/hubspot_sdk/models/crm/public_num_associations_filter.rb', line 72