Class: Trycourier::Models::BulkListUsersResponse::Item

Inherits:
InboundBulkMessageUser show all
Defined in:
lib/trycourier/models/bulk_list_users_response.rb

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Attributes inherited from InboundBulkMessageUser

#data, #preferences, #profile, #recipient, #to

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(items: , paging: ) ⇒ Object

Parameters:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/trycourier/models/bulk_list_users_response.rb', line 22

class Item < Trycourier::Models::InboundBulkMessageUser
  # @!attribute status
  #
  #   @return [Symbol, Trycourier::Models::BulkListUsersResponse::Item::Status]
  required :status, enum: -> { Trycourier::Models::BulkListUsersResponse::Item::Status }

  # @!attribute message_id
  #
  #   @return [String, nil]
  optional :message_id, String, api_name: :messageId, nil?: true

  # @!method initialize(status:, message_id: nil)
  #   @param status [Symbol, Trycourier::Models::BulkListUsersResponse::Item::Status]
  #   @param message_id [String, nil]

  module Status
    extend Trycourier::Internal::Type::Enum

    PENDING = :PENDING
    ENQUEUED = :ENQUEUED
    ERROR = :ERROR

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#message_id ⇒ String?

Returns:

  • (String, nil) 


31
 
# File 'lib/trycourier/models/bulk_list_users_response.rb', line 31

optional :message_id, String, api_name: :messageId, nil?: true

#status ⇒ Symbol, Trycourier::Models::BulkListUsersResponse::Item::Status

Returns:



26
 
# File 'lib/trycourier/models/bulk_list_users_response.rb', line 26

required :status, enum: -> { Trycourier::Models::BulkListUsersResponse::Item::Status }