Class: Telnyx::Models::Dir::PhoneNumberBatch

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/dir/phone_number_batch.rb,
sig/telnyx/models/dir/phone_number_batch.rbs

Overview

See Also:

  • Telnyx::Resources::Dir::PhoneNumberBatches#list

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(batch_id: nil, dir_display_name: nil, dir_id: nil, documents: nil, enterprise_id: nil, phone_numbers: nil, status: nil, submitted_at: nil, total_count: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Dir::PhoneNumberBatch for more details.

A phone-number batch groups all numbers added in a single bulk-add request. Telnyx vets the batch as a unit. The response embeds the full phone_numbers array so you can read per-number status without a separate call, plus a batch-level status summarising the unit's progress.

Parameters:

  • batch_id (String) (defaults to: nil)
  • dir_display_name (String) (defaults to: nil) —

    The DIR's display name at the time the batch was read.

  • dir_id (String) (defaults to: nil)
  • documents (Array<Telnyx::Models::Document>) (defaults to: nil) —

    Documents attached to this batch (e.g. a Letter of Authorization). Empty when no

  • enterprise_id (String) (defaults to: nil)
  • phone_numbers (Array<Telnyx::Models::Dir::DirPhoneNumber>) (defaults to: nil) —

    All phone numbers in this batch, with per-number status.

  • status (Symbol, Telnyx::Models::Dir::DirPhoneNumberStatus) (defaults to: nil) —

    Aggregate batch status. Mirrors the values used on individual phone numbers (`su

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

    When the batch was created (and implicitly submitted for vetting).

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

    Number of phone numbers in this batch (length of phone_numbers).




# File 'lib/telnyx/models/dir/phone_number_batch.rb', line 64

Instance Attribute Details

#batch_id ⇒ String? (readonly)

Returns the value of attribute batch_id.

Returns:

  • (String, nil) 


42
43
44
 
# File 'sig/telnyx/models/dir/phone_number_batch.rbs', line 42

def batch_id
  @batch_id
end

#dir_display_name ⇒ String? (readonly)

Returns the value of attribute dir_display_name.

Returns:

  • (String, nil) 


46
47
48
 
# File 'sig/telnyx/models/dir/phone_number_batch.rbs', line 46

def dir_display_name
  @dir_display_name
end

#dir_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


11
 
# File 'lib/telnyx/models/dir/phone_number_batch.rb', line 11

optional :dir_id, String

#documents ⇒ Array<Telnyx::Models::Document>?

Documents attached to this batch (e.g. a Letter of Authorization). Empty when none were supplied at add time.

Parameters:

Returns:



18
 
# File 'lib/telnyx/models/dir/phone_number_batch.rb', line 18

optional :documents, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Document] }

#enterprise_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


23
 
# File 'lib/telnyx/models/dir/phone_number_batch.rb', line 23

optional :enterprise_id, String

#phone_numbers ⇒ Array<Telnyx::Models::Dir::DirPhoneNumber>?

All phone numbers in this batch, with per-number status.

Returns:



29
 
# File 'lib/telnyx/models/dir/phone_number_batch.rb', line 29

optional :phone_numbers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Dir::DirPhoneNumber] }

#status ⇒ Symbol, ...

Aggregate batch status. Mirrors the values used on individual phone numbers (submitted, in_review, verified, unsuccessful, permanently_rejected, etc.).

Returns:



37
 
# File 'lib/telnyx/models/dir/phone_number_batch.rb', line 37

optional :status, enum: -> { Telnyx::Dir::DirPhoneNumberStatus }

#submitted_at ⇒ Time? (readonly)

Returns the value of attribute submitted_at.

Returns:

  • (Time, nil) 


50
51
52
 
# File 'sig/telnyx/models/dir/phone_number_batch.rbs', line 50

def submitted_at
  @submitted_at
end

#total_count ⇒ Integer? (readonly)

Returns the value of attribute total_count.

Returns:

  • (Integer, nil) 


54
55
56
 
# File 'sig/telnyx/models/dir/phone_number_batch.rbs', line 54

def total_count
  @total_count
end

Instance Method Details

#batch_id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


44
 
# File 'sig/telnyx/models/dir/phone_number_batch.rbs', line 44

def batch_id=: (String) -> String

#dir_display_name= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


48
 
# File 'sig/telnyx/models/dir/phone_number_batch.rbs', line 48

def dir_display_name=: (String) -> String

#submitted_at= ⇒ Time (readonly)

Parameters:

  • (Time)

Returns:

  • (Time) 


52
 
# File 'sig/telnyx/models/dir/phone_number_batch.rbs', line 52

def submitted_at=: (Time) -> Time

#to_hash ⇒ {

Returns:

  • ({) 


70
 
# File 'sig/telnyx/models/dir/phone_number_batch.rbs', line 70

def to_hash: -> {

#total_count= ⇒ Integer (readonly)

Parameters:

  • (Integer)

Returns:

  • (Integer) 


56
 
# File 'sig/telnyx/models/dir/phone_number_batch.rbs', line 56

def total_count=: (Integer) -> Integer