Class: HubSpotSDK::Models::CommunicationPreferences::BatchResponsePublicBulkOptOutFromAllResponse

Inherits:
Internal::Type::BaseModel
  • Object
show all
Defined in:
lib/hubspot_sdk/models/communication_preferences/batch_response_public_bulk_opt_out_from_all_response.rb

Defined Under Namespace

Modules: Status

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(completed_at:, results:, started_at:, status:, errors: nil, links: nil, num_errors: nil, requested_at: nil) ⇒ Object

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

Parameters:

  • completed_at (Time) —

    The date and time when the bulk opt-out operation was completed.

  • results (Array<HubSpotSDK::Models::CommunicationPreferences::PublicBulkOptOutFromAllResponse>) —

    An array containing the results of the bulk opt-out from all communications oper

  • started_at (Time) —

    The date and time when the bulk opt-out operation began.

  • status (Symbol, HubSpotSDK::Models::CommunicationPreferences::BatchResponsePublicBulkOptOutFromAllResponse::Status) —

    The current status of the bulk opt-out operation, which can be PENDING, PROCESSI

  • errors (Array<HubSpotSDK::Models::StandardError>) (defaults to: nil) —

    An array of error objects detailing any issues encountered during the bulk opt-o

  • links (Hash{Symbol=>String}) (defaults to: nil) —

    A collection of URLs linking to related resources or documentation.

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

    The total number of errors encountered during the bulk opt-out operation.

  • requested_at (Time) (defaults to: nil) —

    The date and time when the bulk opt-out request was made.




# File 'lib/hubspot_sdk/models/communication_preferences/batch_response_public_bulk_opt_out_from_all_response.rb', line 60

Instance Attribute Details

#completed_at ⇒ Time

The date and time when the bulk opt-out operation was completed.

Returns:

  • (Time) 


11
 
# File 'lib/hubspot_sdk/models/communication_preferences/batch_response_public_bulk_opt_out_from_all_response.rb', line 11

required :completed_at, Time, api_name: :completedAt

#errors ⇒ Array<HubSpotSDK::Models::StandardError>?

An array of error objects detailing any issues encountered during the bulk opt-out operation.

Returns:



40
 
# File 'lib/hubspot_sdk/models/communication_preferences/batch_response_public_bulk_opt_out_from_all_response.rb', line 40

optional :errors, -> { HubSpotSDK::Internal::Type::ArrayOf[HubSpotSDK::StandardError] }

#links ⇒ Hash{Symbol=>String}?

A collection of URLs linking to related resources or documentation.

Returns:

  • (Hash{Symbol=>String}, nil) 


46
 
# File 'lib/hubspot_sdk/models/communication_preferences/batch_response_public_bulk_opt_out_from_all_response.rb', line 46

optional :links, HubSpotSDK::Internal::Type::HashOf[String]

#num_errors ⇒ Integer?

The total number of errors encountered during the bulk opt-out operation.

Returns:

  • (Integer, nil) 


52
 
# File 'lib/hubspot_sdk/models/communication_preferences/batch_response_public_bulk_opt_out_from_all_response.rb', line 52

optional :num_errors, Integer, api_name: :numErrors

#requested_at ⇒ Time?

The date and time when the bulk opt-out request was made.

Returns:

  • (Time, nil) 


58
 
# File 'lib/hubspot_sdk/models/communication_preferences/batch_response_public_bulk_opt_out_from_all_response.rb', line 58

optional :requested_at, Time, api_name: :requestedAt

#results ⇒ Array<HubSpotSDK::Models::CommunicationPreferences::PublicBulkOptOutFromAllResponse>

An array containing the results of the bulk opt-out from all communications operation.

Returns:



18
19
 
# File 'lib/hubspot_sdk/models/communication_preferences/batch_response_public_bulk_opt_out_from_all_response.rb', line 18

required :results,
-> { HubSpotSDK::Internal::Type::ArrayOf[HubSpotSDK::CommunicationPreferences::PublicBulkOptOutFromAllResponse] }

#started_at ⇒ Time

The date and time when the bulk opt-out operation began.

Returns:

  • (Time) 


25
 
# File 'lib/hubspot_sdk/models/communication_preferences/batch_response_public_bulk_opt_out_from_all_response.rb', line 25

required :started_at, Time, api_name: :startedAt

#status ⇒ Symbol, HubSpotSDK::Models::CommunicationPreferences::BatchResponsePublicBulkOptOutFromAllResponse::Status

The current status of the bulk opt-out operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.

Returns:



32
33
 
# File 'lib/hubspot_sdk/models/communication_preferences/batch_response_public_bulk_opt_out_from_all_response.rb', line 32

required :status,
enum: -> { HubSpotSDK::CommunicationPreferences::BatchResponsePublicBulkOptOutFromAllResponse::Status }