Class: HubSpotSDK::Models::Marketing::EmailSendStatusView

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/hubspot_sdk/models/marketing/email_send_status_view.rb

Defined Under Namespace

Modules: SendResult, Status

Instance Attribute Summary

• #completed_at ⇒ Time^?

  Time when the send was completed.

• #event_id ⇒ HubSpotSDK::Models::Marketing::EventIDView^?
• #message ⇒ String^?

  A human readable message describing the error along with remediation steps where appropriate.

• #requested_at ⇒ Time^?

  Time when the send was requested.

• #send_result ⇒ Symbol, ...

  Result of the send.

• #started_at ⇒ Time^?

  Time when the send began processing.

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

  Status of the send request.

• #status_id ⇒ String

  Identifier used to query the status of the send.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(status:, status_id:, completed_at: nil, event_id: nil, message: nil, requested_at: nil, send_result: nil, started_at: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see EmailSendStatusView 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(status:, status_id:, completed_at: nil, event_id: nil, message: nil, requested_at: nil, send_result: nil, started_at: nil) ⇒ Object

Some parameter documentations has been truncated, see HubSpotSDK::Models::Marketing::EmailSendStatusView for more details.

Parameters:

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

  Status of the send request.

• status_id (String) —

  Identifier used to query the status of the send.

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

  Time when the send was completed.

• event_id (HubSpotSDK::Models::Marketing::EventIDView) (defaults to: nil)
• message (String) (defaults to: nil) —

  A human readable message describing the error along with remediation steps where

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

  Time when the send was requested.

• send_result (Symbol, HubSpotSDK::Models::Marketing::EmailSendStatusView::SendResult) (defaults to: nil) —

  Result of the send.

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

  Time when the send began processing.

# File 'lib/hubspot_sdk/models/marketing/email_send_status_view.rb', line 57

Instance Attribute Details

#completed_at ⇒ Time^?

Time when the send was completed.

Returns:

• (Time, nil)

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

optional :completed_at, Time, api_name: :completedAt

#event_id ⇒ HubSpotSDK::Models::Marketing::EventIDView^?

Returns:

• (HubSpotSDK::Models::Marketing::EventIDView, nil)

# File 'lib/hubspot_sdk/models/marketing/email_send_status_view.rb', line 28

optional :event_id, -> { HubSpotSDK::Marketing::EventIDView }, api_name: :eventId

#message ⇒ String^?

A human readable message describing the error along with remediation steps where appropriate

Returns:

• (String, nil)

# File 'lib/hubspot_sdk/models/marketing/email_send_status_view.rb', line 35

optional :message, String

#requested_at ⇒ Time^?

Time when the send was requested.

Returns:

• (Time, nil)

# File 'lib/hubspot_sdk/models/marketing/email_send_status_view.rb', line 41

optional :requested_at, Time, api_name: :requestedAt

#send_result ⇒ Symbol, ...

Result of the send.

Returns:

• (Symbol, HubSpotSDK::Models::Marketing::EmailSendStatusView::SendResult, nil)

# File 'lib/hubspot_sdk/models/marketing/email_send_status_view.rb', line 47

optional :send_result,
enum: -> { HubSpotSDK::Marketing::EmailSendStatusView::SendResult },
api_name: :sendResult

#started_at ⇒ Time^?

Time when the send began processing.

Returns:

• (Time, nil)

# File 'lib/hubspot_sdk/models/marketing/email_send_status_view.rb', line 55

optional :started_at, Time, api_name: :startedAt

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

Status of the send request.

Returns:

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

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

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

#status_id ⇒ String

Identifier used to query the status of the send.

Returns:

• (String)

# File 'lib/hubspot_sdk/models/marketing/email_send_status_view.rb', line 17

required :status_id, String, api_name: :statusId

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/hubspot_sdk/models/marketing/email_send_status_view.rb', line 88