Class: Zavudev::Models::BroadcastProgress

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Zavudev::Models::BroadcastProgress

Defined in:

lib/zavudev/models/broadcast_progress.rb

Overview

See Also:

• Resources::Broadcasts#progress

Instance Attribute Summary

• #actual_cost ⇒ Float^?

  Actual cost so far in USD.

• #broadcast_id ⇒ String
• #delivered ⇒ Integer

  Successfully delivered.

• #estimated_completion_at ⇒ Time^?
• #estimated_cost ⇒ Float^?

  Estimated total cost in USD.

• #failed ⇒ Integer

  Failed to deliver.

• #pending ⇒ Integer

  Not yet queued for sending.

• #percent_complete ⇒ Float

  Percentage complete (0-100).

• #reserved_amount ⇒ Float^?

  Amount reserved from balance in USD.

• #sending ⇒ Integer

  Currently being sent.

• #skipped ⇒ Integer

  Skipped (broadcast cancelled).

• #started_at ⇒ Time^?
• #status ⇒ Symbol, Zavudev::Models::BroadcastStatus

  Current status of the broadcast.

• #total ⇒ Integer

  Total contacts in broadcast.

Instance Method Summary

• #initialize(broadcast_id:, delivered:, failed:, pending:, percent_complete:, sending:, skipped:, status:, total:, actual_cost: nil, estimated_completion_at: nil, estimated_cost: nil, reserved_amount: nil, started_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(broadcast_id:, delivered:, failed:, pending:, percent_complete:, sending:, skipped:, status:, total:, actual_cost: nil, estimated_completion_at: nil, estimated_cost: nil, reserved_amount: nil, started_at: nil) ⇒ Object

Parameters:

• broadcast_id (String)
• delivered (Integer) —

  Successfully delivered.

• failed (Integer) —

  Failed to deliver.

• pending (Integer) —

  Not yet queued for sending.

• percent_complete (Float) —

  Percentage complete (0-100).

• sending (Integer) —

  Currently being sent.

• skipped (Integer) —

  Skipped (broadcast cancelled).

• status (Symbol, Zavudev::Models::BroadcastStatus) —

  Current status of the broadcast.

• total (Integer) —

  Total contacts in broadcast.

• actual_cost (Float, nil) (defaults to: nil) —

  Actual cost so far in USD.

• estimated_completion_at (Time) (defaults to: nil)
• estimated_cost (Float, nil) (defaults to: nil) —

  Estimated total cost in USD.

• reserved_amount (Float, nil) (defaults to: nil) —

  Amount reserved from balance in USD.

• started_at (Time) (defaults to: nil)

# File 'lib/zavudev/models/broadcast_progress.rb', line 88

Instance Attribute Details

#actual_cost ⇒ Float^?

Actual cost so far in USD.

Returns:

• (Float, nil)

# File 'lib/zavudev/models/broadcast_progress.rb', line 64

optional :actual_cost, Float, api_name: :actualCost, nil?: true

#broadcast_id ⇒ String

Returns:

• (String)

# File 'lib/zavudev/models/broadcast_progress.rb', line 10

required :broadcast_id, String, api_name: :broadcastId

#delivered ⇒ Integer

Successfully delivered.

Returns:

• (Integer)

# File 'lib/zavudev/models/broadcast_progress.rb', line 16

required :delivered, Integer

#estimated_completion_at ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/zavudev/models/broadcast_progress.rb', line 69

optional :estimated_completion_at, Time, api_name: :estimatedCompletionAt

#estimated_cost ⇒ Float^?

Estimated total cost in USD.

Returns:

• (Float, nil)

# File 'lib/zavudev/models/broadcast_progress.rb', line 75

optional :estimated_cost, Float, api_name: :estimatedCost, nil?: true

#failed ⇒ Integer

Failed to deliver.

Returns:

• (Integer)

# File 'lib/zavudev/models/broadcast_progress.rb', line 22

required :failed, Integer

#pending ⇒ Integer

Not yet queued for sending.

Returns:

• (Integer)

# File 'lib/zavudev/models/broadcast_progress.rb', line 28

required :pending, Integer

#percent_complete ⇒ Float

Percentage complete (0-100).

Returns:

• (Float)

# File 'lib/zavudev/models/broadcast_progress.rb', line 34

required :percent_complete, Float, api_name: :percentComplete

#reserved_amount ⇒ Float^?

Amount reserved from balance in USD.

Returns:

• (Float, nil)

# File 'lib/zavudev/models/broadcast_progress.rb', line 81

optional :reserved_amount, Float, api_name: :reservedAmount, nil?: true

#sending ⇒ Integer

Currently being sent.

Returns:

• (Integer)

# File 'lib/zavudev/models/broadcast_progress.rb', line 40

required :sending, Integer

#skipped ⇒ Integer

Skipped (broadcast cancelled).

Returns:

• (Integer)

# File 'lib/zavudev/models/broadcast_progress.rb', line 46

required :skipped, Integer

#started_at ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/zavudev/models/broadcast_progress.rb', line 86

optional :started_at, Time, api_name: :startedAt

#status ⇒ Symbol, Zavudev::Models::BroadcastStatus

Current status of the broadcast.

Returns:

• (Symbol, Zavudev::Models::BroadcastStatus)

# File 'lib/zavudev/models/broadcast_progress.rb', line 52

required :status, enum: -> { Zavudev::BroadcastStatus }

#total ⇒ Integer

Total contacts in broadcast.

Returns:

• (Integer)

# File 'lib/zavudev/models/broadcast_progress.rb', line 58

required :total, Integer