Class: HubSpotSDK::Models::Crm::PublicCommunicationSubscriptionFilter

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

Defined Under Namespace

Modules: FilterType

Instance Attribute 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(accepted_opt_states:, channel:, filter_type:, subscription_ids:, subscription_type:, business_unit_id: nil) ⇒ Object

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

Parameters:

  • accepted_opt_states (Array<String>)
  • channel (String) —

    Specifies the communication channel associated with the subscription filter (EMA

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

    Indicates the type of filter, which is (COMMUNICATION_SUBSCRIPTION)

  • subscription_ids (Array<String>)
  • subscription_type (String) —

    Defines the type of subscription related to the filter (PORTAL_WIDE, BUSINESS_UN

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

    The ID of the business unit associated with the subscription filter.




# File 'lib/hubspot_sdk/models/crm/public_communication_subscription_filter.rb', line 47

Instance Attribute Details

#accepted_opt_states ⇒ Array<String>

Returns:

  • (Array<String>) 


10
11
12
 
# File 'lib/hubspot_sdk/models/crm/public_communication_subscription_filter.rb', line 10

required :accepted_opt_states,
HubSpotSDK::Internal::Type::ArrayOf[String],
api_name: :acceptedOptStates

#business_unit_id ⇒ String?

The ID of the business unit associated with the subscription filter.

Returns:

  • (String, nil) 


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

optional :business_unit_id, String, api_name: :businessUnitId

#channel ⇒ String

Specifies the communication channel associated with the subscription filter (EMAIL, WHATSAPP, SMS).

Returns:

  • (String) 


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

required :channel, String

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

Indicates the type of filter, which is (COMMUNICATION_SUBSCRIPTION)

Returns:



25
26
27
 
# File 'lib/hubspot_sdk/models/crm/public_communication_subscription_filter.rb', line 25

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

#subscription_ids ⇒ Array<String>

Returns:

  • (Array<String>) 


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

required :subscription_ids, HubSpotSDK::Internal::Type::ArrayOf[String], api_name: :subscriptionIds

#subscription_type ⇒ String

Defines the type of subscription related to the filter (PORTAL_WIDE, BUSINESS_UNIT_WIDE, INDIVIDUAL_SUBSCRIPTION)

Returns:

  • (String) 


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

required :subscription_type, String, api_name: :subscriptionType