Class: HubSpotSDK::Models::CommunicationPreferences::ActionResponseWithResultsPublicStatus

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/hubspot_sdk/models/communication_preferences/action_response_with_results_public_status.rb

Overview

See Also:

• Resources::CommunicationPreferences#get_statuses

Defined Under Namespace

Modules: Status

Instance Attribute Summary

• #completed_at ⇒ Time

  The date and time when the operation was completed.

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

  A list of errors that occurred during the operation.

• #links ⇒ Hash{Symbol=>String}^?

  Contains URLs related to the response, such as documentation or resources.

• #num_errors ⇒ Integer^?

  The number of errors that occurred during the operation.

• #requested_at ⇒ Time^?

  The date and time when the request was made.

• #results ⇒ Array<HubSpotSDK::Models::CommunicationPreferences::PublicStatus>

  An array of results from the operation.

• #started_at ⇒ Time

  The date and time when the operation started.

• #status ⇒ Symbol, HubSpotSDK::Models::CommunicationPreferences::ActionResponseWithResultsPublicStatus::Status

  Indicates the current status of the operation, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.

Instance Method Summary

• #initialize(completed_at:, results:, started_at:, status:, errors: nil, links: nil, num_errors: nil, requested_at: nil) ⇒ Object constructor

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

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::ActionResponseWithResultsPublicStatus for more details.

Parameters:

• completed_at (Time) —

  The date and time when the operation was completed.

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

  An array of results from the operation.

• started_at (Time) —

  The date and time when the operation started.

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

  Indicates the current status of the operation, with possible values: PENDING, PR

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

  A list of errors that occurred during the operation.

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

  Contains URLs related to the response, such as documentation or resources.

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

  The number of errors that occurred during the operation.

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

  The date and time when the request was made.

# File 'lib/hubspot_sdk/models/communication_preferences/action_response_with_results_public_status.rb', line 59

Instance Attribute Details

#completed_at ⇒ Time

The date and time when the operation was completed.

Returns:

• (Time)

# File 'lib/hubspot_sdk/models/communication_preferences/action_response_with_results_public_status.rb', line 12

required :completed_at, Time, api_name: :completedAt

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

A list of errors that occurred during the operation.

Returns:

• (Array<HubSpotSDK::Models::StandardError>, nil)

# File 'lib/hubspot_sdk/models/communication_preferences/action_response_with_results_public_status.rb', line 39

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

#links ⇒ Hash{Symbol=>String}^?

Contains URLs related to the response, such as documentation or resources.

Returns:

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

# File 'lib/hubspot_sdk/models/communication_preferences/action_response_with_results_public_status.rb', line 45

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

#num_errors ⇒ Integer^?

The number of errors that occurred during the operation.

Returns:

• (Integer, nil)

# File 'lib/hubspot_sdk/models/communication_preferences/action_response_with_results_public_status.rb', line 51

optional :num_errors, Integer, api_name: :numErrors

#requested_at ⇒ Time^?

The date and time when the request was made.

Returns:

• (Time, nil)

# File 'lib/hubspot_sdk/models/communication_preferences/action_response_with_results_public_status.rb', line 57

optional :requested_at, Time, api_name: :requestedAt

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

An array of results from the operation.

Returns:

• (Array<HubSpotSDK::Models::CommunicationPreferences::PublicStatus>)

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

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

#started_at ⇒ Time

The date and time when the operation started.

Returns:

• (Time)

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

required :started_at, Time, api_name: :startedAt

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

Indicates the current status of the operation, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.

Returns:

• (Symbol, HubSpotSDK::Models::CommunicationPreferences::ActionResponseWithResultsPublicStatus::Status)

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

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