Class: HubSpotSDK::Resources::CommunicationPreferences::Statuses::Batch

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot_sdk/resources/communication_preferences/statuses/batch.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Batch

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Batch.

Parameters:



141
142
143
 
# File 'lib/hubspot_sdk/resources/communication_preferences/statuses/batch.rb', line 141

def initialize(client:)
  @client = client
end

Instance Method Details

#get_unsubscribe_all_statuses(channel:, inputs:, business_unit_id: nil, request_options: {}) ⇒ HubSpotSDK::Models::CommunicationPreferences::BatchResponsePublicWideStatusBulkResponse

Some parameter documentations has been truncated, see Models::CommunicationPreferences::Statuses::BatchGetUnsubscribeAllStatusesParams for more details.

Checks whether a set of contacts have opted out of all communications.

Parameters:

  • channel (Symbol, HubSpotSDK::Models::BatchInputString::Channel) —

    Query param: The communication channel to filter the unsubscribe statuses. This

  • inputs (Array<String>) —

    Body param: Strings to input.

  • business_unit_id (Integer) —

    Query param: The ID of the business unit to filter the results. This is an optio

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

Returns:

See Also:



27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/hubspot_sdk/resources/communication_preferences/statuses/batch.rb', line 27

def get_unsubscribe_all_statuses(params)
  query_params = [:channel, :business_unit_id]
  parsed, options =
    HubSpotSDK::CommunicationPreferences::Statuses::BatchGetUnsubscribeAllStatusesParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :post,
    path: "communication-preferences/2026-03/statuses/batch/unsubscribe-all/read",
    query: query.transform_keys(business_unit_id: "businessUnitId"),
    body: parsed.except(*query_params),
    model: HubSpotSDK::CommunicationPreferences::BatchResponsePublicWideStatusBulkResponse,
    options: options
  )
end

#read(channel:, inputs:, business_unit_id: nil, request_options: {}) ⇒ HubSpotSDK::Models::CommunicationPreferences::BatchResponsePublicStatusBulkResponse

Some parameter documentations has been truncated, see Models::CommunicationPreferences::Statuses::BatchReadParams for more details.

Batch retrieve subscription statuses for a set of contacts.

Parameters:

  • channel (Symbol, HubSpotSDK::Models::BatchInputString::Channel) —

    Query param: The communication channel to filter the subscription statuses. Must

  • inputs (Array<String>) —

    Body param: Strings to input.

  • business_unit_id (Integer) —

    Query param: An optional integer representing the business unit ID. This paramet

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

Returns:

See Also:



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/hubspot_sdk/resources/communication_preferences/statuses/batch.rb', line 61

def read(params)
  query_params = [:channel, :business_unit_id]
  parsed, options = HubSpotSDK::CommunicationPreferences::Statuses::BatchReadParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :post,
    path: "communication-preferences/2026-03/statuses/batch/read",
    query: query.transform_keys(business_unit_id: "businessUnitId"),
    body: parsed.except(*query_params),
    model: HubSpotSDK::CommunicationPreferences::BatchResponsePublicStatusBulkResponse,
    options: options
  )
end

#unsubscribe_all(channel:, inputs:, business_unit_id: nil, verbose: nil, request_options: {}) ⇒ HubSpotSDK::Models::CommunicationPreferences::BatchResponsePublicBulkOptOutFromAllResponse

Some parameter documentations has been truncated, see Models::CommunicationPreferences::Statuses::BatchUnsubscribeAllParams for more details.

Unsubscribe a set of contacts from all email subscriptions.

Parameters:

  • channel (Symbol, HubSpotSDK::Models::BatchInputString::Channel) —

    Query param: The communication channel from which subscribers will be unsubscrib

  • inputs (Array<String>) —

    Body param: Strings to input.

  • business_unit_id (Integer) —

    Query param: An optional integer representing the business unit ID for which the

  • verbose (Boolean) —

    Query param: A boolean indicating whether to include detailed information in the

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

Returns:

See Also:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/hubspot_sdk/resources/communication_preferences/statuses/batch.rb', line 96

def unsubscribe_all(params)
  query_params = [:channel, :business_unit_id, :verbose]
  parsed, options =
    HubSpotSDK::CommunicationPreferences::Statuses::BatchUnsubscribeAllParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :post,
    path: "communication-preferences/2026-03/statuses/batch/unsubscribe-all",
    query: query.transform_keys(business_unit_id: "businessUnitId"),
    body: parsed.except(*query_params),
    model: HubSpotSDK::CommunicationPreferences::BatchResponsePublicBulkOptOutFromAllResponse,
    options: options
  )
end

#update_statuses(inputs:, request_options: {}) ⇒ HubSpotSDK::Models::CommunicationPreferences::BatchResponsePublicStatus

Some parameter documentations has been truncated, see Models::CommunicationPreferences::Statuses::BatchUpdateStatusesParams for more details.

Update the subscription status for a set of contacts.

Parameters:

Returns:

See Also:



126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/hubspot_sdk/resources/communication_preferences/statuses/batch.rb', line 126

def update_statuses(params)
  parsed, options =
    HubSpotSDK::CommunicationPreferences::Statuses::BatchUpdateStatusesParams.dump_request(params)
  @client.request(
    method: :post,
    path: "communication-preferences/2026-03/statuses/batch/write",
    body: parsed,
    model: HubSpotSDK::CommunicationPreferences::BatchResponsePublicStatus,
    options: options
  )
end