Class: HubSpotSDK::Models::Crm::PublicCtaAnalyticsFilter

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/hubspot_sdk/models/crm/public_cta_analytics_filter.rb

Defined Under Namespace

Modules: CoalescingRefineBy, FilterType, PruningRefineBy

Instance Attribute Summary

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

  Specifies the criteria for refining the filter by coalescing.

• #cta_name ⇒ String

  The name of the Call-to-Action (CTA) to be used in the filter.

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

  Indicates the type of filter being applied, which is (CTA).

• #operator ⇒ String

  Defines the operation to be applied within the filter (HAS_CLICKED_CTA, HAS_NOT_CLICKED_CTA, HAS_OPENED_CTA, HAS_NOT_OPENED_CTA, HAS_CLICKED_CTA_PLACEMENT, HAS_NOT_CLICKED_CTA_PLACEMENT, HAS_OPENED_CTA_PLACEMENT, HAS_NOT_OPENED_CTA_PLACEMENT).

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

  Specifies the criteria for refining the filter by pruning.

Class Method Summary

• .values ⇒ Array<Symbol>
• .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(cta_name:, filter_type:, operator:, coalescing_refine_by: nil, pruning_refine_by: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see PublicCtaAnalyticsFilter 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(cta_name:, filter_type:, operator:, coalescing_refine_by: nil, pruning_refine_by: nil) ⇒ Object

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

Parameters:

• cta_name (String) —

  The name of the Call-to-Action (CTA) to be used in the filter.

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

  Indicates the type of filter being applied, which is (CTA).

• operator (String) —

  Defines the operation to be applied within the filter (HAS*CLICKED_CTA, HAS_NOT*

• 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) (defaults to: nil) —

  Specifies the criteria for refining the filter by coalescing.

• pruning_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) (defaults to: nil) —

  Specifies the criteria for refining the filter by pruning.

# File 'lib/hubspot_sdk/models/crm/public_cta_analytics_filter.rb', line 46

Instance Attribute Details

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

Specifies the criteria for refining the filter by coalescing.

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, nil)

# File 'lib/hubspot_sdk/models/crm/public_cta_analytics_filter.rb', line 34

optional :coalescing_refine_by,
union: -> { HubSpotSDK::Crm::PublicCtaAnalyticsFilter::CoalescingRefineBy },
api_name: :coalescingRefineBy

#cta_name ⇒ String

The name of the Call-to-Action (CTA) to be used in the filter.

Returns:

• (String)

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

required :cta_name, String, api_name: :ctaName

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

Indicates the type of filter being applied, which is (CTA).

Returns:

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

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

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

#operator ⇒ String

Defines the operation to be applied within the filter (HAS_CLICKED_CTA, HAS_NOT_CLICKED_CTA, HAS_OPENED_CTA, HAS_NOT_OPENED_CTA, HAS_CLICKED_CTA_PLACEMENT, HAS_NOT_CLICKED_CTA_PLACEMENT, HAS_OPENED_CTA_PLACEMENT, HAS_NOT_OPENED_CTA_PLACEMENT).

Returns:

• (String)

# File 'lib/hubspot_sdk/models/crm/public_cta_analytics_filter.rb', line 28

required :operator, String

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

Specifies the criteria for refining the filter by pruning.

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, nil)

# File 'lib/hubspot_sdk/models/crm/public_cta_analytics_filter.rb', line 42

optional :pruning_refine_by,
union: -> { HubSpotSDK::Crm::PublicCtaAnalyticsFilter::PruningRefineBy },
api_name: :pruningRefineBy

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/hubspot_sdk/models/crm/public_cta_analytics_filter.rb', line 68

.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_cta_analytics_filter.rb', line 96