Class: HubSpotSDK::Models::Crm::PublicPageViewAnalyticsFilter

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

Defined Under Namespace

Modules: CoalescingRefineBy, FilterType, PruningRefineBy

Instance Attribute Summary collapse

Class Method 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_type:, operator:, page_url:, coalescing_refine_by: nil, enable_tracking: nil, pruning_refine_by: nil) ⇒ Object

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

Parameters:




# File 'lib/hubspot_sdk/models/crm/public_page_view_analytics_filter.rb', line 51

Instance Attribute Details

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

Specifies the criteria for refining the filter by coalescing.

Returns:



33
34
35
 
# File 'lib/hubspot_sdk/models/crm/public_page_view_analytics_filter.rb', line 33

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

#enable_tracking ⇒ Boolean?

Indicates whether tracking is enabled for the page view.

Returns:

  • (Boolean, nil) 


41
 
# File 'lib/hubspot_sdk/models/crm/public_page_view_analytics_filter.rb', line 41

optional :enable_tracking, HubSpotSDK::Internal::Type::Boolean, api_name: :enableTracking

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

Indicates the type of filter being applied (PAGE_VIEW).

Returns:



11
12
13
 
# File 'lib/hubspot_sdk/models/crm/public_page_view_analytics_filter.rb', line 11

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

#operator ⇒ String

Defines the operation to be applied within the filter (HAS_PAGEVIEW_EQ, HAS_PAGEVIEW_CONTAINS, HAS_PAGEVIEW_MATCHES_REGEX, NOT_HAS_PAGEVIEW_EQ, NOT_HAS_PAGEVIEW_CONTAINS).

Returns:

  • (String) 


21
 
# File 'lib/hubspot_sdk/models/crm/public_page_view_analytics_filter.rb', line 21

required :operator, String

#page_url ⇒ String

The URL of the page to be used in the filter.

Returns:

  • (String) 


27
 
# File 'lib/hubspot_sdk/models/crm/public_page_view_analytics_filter.rb', line 27

required :page_url, String, api_name: :pageUrl

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

Specifies the criteria for refining the filter by pruning.

Returns:



47
48
49
 
# File 'lib/hubspot_sdk/models/crm/public_page_view_analytics_filter.rb', line 47

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