Class: HubSpotSDK::Models::CommunicationPreferences::CommunicationPreferenceGetStatusesParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• HubSpotSDK::Models::CommunicationPreferences::CommunicationPreferenceGetStatusesParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/hubspot_sdk/models/communication_preferences/communication_preference_get_statuses_params.rb

Overview

See Also:

• Resources::CommunicationPreferences#get_statuses

Defined Under Namespace

Modules: Channel

Instance Attribute Summary

• #business_unit_id ⇒ Integer^?

  The ID of the business unit to filter the subscription status by.

• #channel ⇒ Symbol, HubSpotSDK::Models::CommunicationPreferences::CommunicationPreferenceGetStatusesParams::Channel

  The communication channel for which the subscription status is being retrieved.

• #subscriber_id_string ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(subscriber_id_string:, channel:, business_unit_id: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see CommunicationPreferenceGetStatusesParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(subscriber_id_string:, channel:, business_unit_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see HubSpotSDK::Models::CommunicationPreferences::CommunicationPreferenceGetStatusesParams for more details.

Parameters:

• subscriber_id_string (String)
• channel (Symbol, HubSpotSDK::Models::CommunicationPreferences::CommunicationPreferenceGetStatusesParams::Channel) —

  The communication channel for which the subscription status is being retrieved.

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

  The ID of the business unit to filter the subscription status by. This is an opt

• request_options (HubSpotSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/hubspot_sdk/models/communication_preferences/communication_preference_get_statuses_params.rb', line 31

Instance Attribute Details

#business_unit_id ⇒ Integer^?

The ID of the business unit to filter the subscription status by. This is an optional parameter.

Returns:

• (Integer, nil)

# File 'lib/hubspot_sdk/models/communication_preferences/communication_preference_get_statuses_params.rb', line 29

optional :business_unit_id, Integer

#channel ⇒ Symbol, HubSpotSDK::Models::CommunicationPreferences::CommunicationPreferenceGetStatusesParams::Channel

The communication channel for which the subscription status is being retrieved. This parameter is required and currently supports only ‘EMAIL’.

Returns:

• (Symbol, HubSpotSDK::Models::CommunicationPreferences::CommunicationPreferenceGetStatusesParams::Channel)

# File 'lib/hubspot_sdk/models/communication_preferences/communication_preference_get_statuses_params.rb', line 21

required :channel,
enum: -> { HubSpotSDK::CommunicationPreferences::CommunicationPreferenceGetStatusesParams::Channel }

#subscriber_id_string ⇒ String

Returns:

• (String)

# File 'lib/hubspot_sdk/models/communication_preferences/communication_preference_get_statuses_params.rb', line 14

required :subscriber_id_string, String