Class: HubSpotSDK::Models::Marketing::BatchResponseSubscriberVidResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• HubSpotSDK::Models::Marketing::BatchResponseSubscriberVidResponse

Defined in:

lib/hubspot_sdk/models/marketing/batch_response_subscriber_vid_response.rb

Defined Under Namespace

Modules: Status

Instance Attribute Summary

• #completed_at ⇒ Time

  Timestamp that represents when the request finished processing.

• #errors ⇒ Array<HubSpotSDK::Models::StandardError>^?
• #links ⇒ Hash{Symbol=>String}^?

  Result of the request.

• #num_errors ⇒ Integer^?

  The number of errors that occurred during the processing.

• #requested_at ⇒ Time^?

  Timestamp that represents when the request was made.

• #results ⇒ Array<HubSpotSDK::Models::Marketing::SubscriberVidResponse>
• #started_at ⇒ Time

  Timestamp that represents when the request started processing.

• #status ⇒ Symbol, HubSpotSDK::Models::Marketing::BatchResponseSubscriberVidResponse::Status

  The status of the request processing.

Instance Method Summary

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

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

Parameters:

• completed_at (Time) —

  Timestamp that represents when the request finished processing

• results (Array<HubSpotSDK::Models::Marketing::SubscriberVidResponse>)
• started_at (Time) —

  Timestamp that represents when the request started processing

• status (Symbol, HubSpotSDK::Models::Marketing::BatchResponseSubscriberVidResponse::Status) —

  The status of the request processing

• errors (Array<HubSpotSDK::Models::StandardError>) (defaults to: nil)
• links (Hash{Symbol=>String}) (defaults to: nil) —

  Result of the request

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

  The number of errors that occurred during the processing

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

  Timestamp that represents when the request was made

# File 'lib/hubspot_sdk/models/marketing/batch_response_subscriber_vid_response.rb', line 54

Instance Attribute Details

#completed_at ⇒ Time

Timestamp that represents when the request finished processing

Returns:

• (Time)

# File 'lib/hubspot_sdk/models/marketing/batch_response_subscriber_vid_response.rb', line 11

required :completed_at, Time, api_name: :completedAt

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

Returns:

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

# File 'lib/hubspot_sdk/models/marketing/batch_response_subscriber_vid_response.rb', line 34

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

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

Result of the request

Returns:

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

# File 'lib/hubspot_sdk/models/marketing/batch_response_subscriber_vid_response.rb', line 40

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

#num_errors ⇒ Integer^?

The number of errors that occurred during the processing

Returns:

• (Integer, nil)

# File 'lib/hubspot_sdk/models/marketing/batch_response_subscriber_vid_response.rb', line 46

optional :num_errors, Integer, api_name: :numErrors

#requested_at ⇒ Time^?

Timestamp that represents when the request was made

Returns:

• (Time, nil)

# File 'lib/hubspot_sdk/models/marketing/batch_response_subscriber_vid_response.rb', line 52

optional :requested_at, Time, api_name: :requestedAt

#results ⇒ Array<HubSpotSDK::Models::Marketing::SubscriberVidResponse>

Returns:

• (Array<HubSpotSDK::Models::Marketing::SubscriberVidResponse>)

# File 'lib/hubspot_sdk/models/marketing/batch_response_subscriber_vid_response.rb', line 16

required :results,
-> { HubSpotSDK::Internal::Type::ArrayOf[HubSpotSDK::Marketing::SubscriberVidResponse] }

#started_at ⇒ Time

Timestamp that represents when the request started processing

Returns:

• (Time)

# File 'lib/hubspot_sdk/models/marketing/batch_response_subscriber_vid_response.rb', line 23

required :started_at, Time, api_name: :startedAt

#status ⇒ Symbol, HubSpotSDK::Models::Marketing::BatchResponseSubscriberVidResponse::Status

The status of the request processing

Returns:

• (Symbol, HubSpotSDK::Models::Marketing::BatchResponseSubscriberVidResponse::Status)

# File 'lib/hubspot_sdk/models/marketing/batch_response_subscriber_vid_response.rb', line 29

required :status, enum: -> { HubSpotSDK::Marketing::BatchResponseSubscriberVidResponse::Status }