Class: Trycourier::Models::BulkRetrieveJobResponse::Job

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/trycourier/models/bulk_retrieve_job_response.rb

Overview

See Also:

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(definition:, enqueued:, failures:, received:, status:) ⇒ Object

Some parameter documentations has been truncated, see Trycourier::Models::BulkRetrieveJobResponse::Job for more details.

Parameters:




# File 'lib/trycourier/models/bulk_retrieve_job_response.rb', line 47

Instance Attribute Details

#definition ⇒ Trycourier::Models::InboundBulkMessage

Bulk message definition. Supports two formats:

  • V1 format: Requires event field (event ID or notification ID)

  • V2 format: Optionally use template (notification ID) or content (Elemental content) in addition to event

Returns:



25
 
# File 'lib/trycourier/models/bulk_retrieve_job_response.rb', line 25

required :definition, -> { Trycourier::InboundBulkMessage }

#enqueued ⇒ Integer

Returns:

  • (Integer) 


30
 
# File 'lib/trycourier/models/bulk_retrieve_job_response.rb', line 30

required :enqueued, Integer

#failures ⇒ Integer

Returns:

  • (Integer) 


35
 
# File 'lib/trycourier/models/bulk_retrieve_job_response.rb', line 35

required :failures, Integer

#received ⇒ Integer

Returns:

  • (Integer) 


40
 
# File 'lib/trycourier/models/bulk_retrieve_job_response.rb', line 40

required :received, Integer

#status ⇒ Symbol, Trycourier::Models::BulkRetrieveJobResponse::Job::Status

Returns:



45
 
# File 'lib/trycourier/models/bulk_retrieve_job_response.rb', line 45

required :status, enum: -> { Trycourier::Models::BulkRetrieveJobResponse::Job::Status }