Class: HubSpotSDK::Models::Crm::PublicFormSubmissionOnPageFilter

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

Defined Under Namespace

Modules: CoalescingRefineBy, FilterType, Operator, 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_id:, coalescing_refine_by: nil, form_id: nil, pruning_refine_by: nil) ⇒ Object

Parameters:




# File 'lib/hubspot_sdk/models/crm/public_form_submission_on_page_filter.rb', line 49

Instance Attribute Details

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

Defines the criteria for refining the filter by coalescing.

Returns:



31
32
33
 
# File 'lib/hubspot_sdk/models/crm/public_form_submission_on_page_filter.rb', line 31

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

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

Indicates the type of filter (FORM_SUBMISSION_ON_PAGE).

Returns:



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

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

#form_id ⇒ String?

The ID of the form associated with the submission filter.

Returns:

  • (String, nil) 


39
 
# File 'lib/hubspot_sdk/models/crm/public_form_submission_on_page_filter.rb', line 39

optional :form_id, String, api_name: :formId

#operator ⇒ Symbol, HubSpotSDK::Models::Crm::PublicFormSubmissionOnPageFilter::Operator

Specifies the operation to be applied (FILLED_OUT, NOT_FILLED_OUT).

Returns:



19
 
# File 'lib/hubspot_sdk/models/crm/public_form_submission_on_page_filter.rb', line 19

required :operator, enum: -> { HubSpotSDK::Crm::PublicFormSubmissionOnPageFilter::Operator }

#page_id ⇒ String

The ID of the page where the form submission occurred.

Returns:

  • (String) 


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

required :page_id, String, api_name: :pageId

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

Specifies the criteria for refining the filter by pruning.

Returns:



45
46
47
 
# File 'lib/hubspot_sdk/models/crm/public_form_submission_on_page_filter.rb', line 45

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