Class: Telnyx::Models::Dir::PhoneNumberAddParams::Document

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/dir/phone_number_add_params.rb

Defined Under Namespace

Modules: DocumentType

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(document_id:, document_type:, description: nil) ⇒ Object

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

Parameters:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/telnyx/models/dir/phone_number_add_params.rb', line 45

class Document < Telnyx::Internal::Type::BaseModel
  # @!attribute document_id
  #   Id returned by the Telnyx Documents API after you upload the file (upload via
  #   `POST /v2/documents`; see https://developers.telnyx.com/api/documents).
  #
  #   @return [String]
  required :document_id, String

  # @!attribute document_type
  #   Type of supporting document. Pick the closest match to what the file actually
  #   contains; `other` triggers manual vetting and may slow approval. The matching
  #   short_name reference list is at `GET /v2/dir/document_types`.
  #
  #   @return [Symbol, Telnyx::Models::Dir::PhoneNumberAddParams::Document::DocumentType]
  required :document_type, enum: -> { Telnyx::Dir::PhoneNumberAddParams::Document::DocumentType }

  # @!attribute description
  #
  #   @return [String, nil]
  optional :description, String

  # @!method initialize(document_id:, document_type:, description: nil)
  #   Some parameter documentations has been truncated, see
  #   {Telnyx::Models::Dir::PhoneNumberAddParams::Document} for more details.
  #
  #   @param document_id [String] Id returned by the Telnyx Documents API after you upload the file (upload via `P
  #
  #   @param document_type [Symbol, Telnyx::Models::Dir::PhoneNumberAddParams::Document::DocumentType] Type of supporting document. Pick the closest match to what the file actually co
  #
  #   @param description [String]

  # Type of supporting document. Pick the closest match to what the file actually
  # contains; `other` triggers manual vetting and may slow approval. The matching
  # short_name reference list is at `GET /v2/dir/document_types`.
  #
  # @see Telnyx::Models::Dir::PhoneNumberAddParams::Document#document_type
  module DocumentType
    extend Telnyx::Internal::Type::Enum

    LETTER_OF_AUTHORIZATION = :letter_of_authorization
    BUSINESS_REGISTRATION = :business_registration
    ARTICLES_OF_INCORPORATION = :articles_of_incorporation
    TAX_DOCUMENT = :tax_document
    EIN_LETTER = :ein_letter
    TRADEMARK_REGISTRATION = :trademark_registration
    WEBSITE_OWNERSHIP = :website_ownership
    BUSINESS_LICENSE = :business_license
    PROFESSIONAL_LICENSE = :professional_license
    GOVERNMENT_ID = :government_id
    UTILITY_BILL = :utility_bill
    BANK_STATEMENT = :bank_statement
    OTHER = :other

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

Instance Attribute Details

#description ⇒ String?

Returns:

  • (String, nil) 


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

optional :description, String

#document_id ⇒ String

Id returned by the Telnyx Documents API after you upload the file (upload via ‘POST /v2/documents`; see developers.telnyx.com/api/documents).

Returns:

  • (String) 


51
 
# File 'lib/telnyx/models/dir/phone_number_add_params.rb', line 51

required :document_id, String

#document_type ⇒ Symbol, Telnyx::Models::Dir::PhoneNumberAddParams::Document::DocumentType

Type of supporting document. Pick the closest match to what the file actually contains; ‘other` triggers manual vetting and may slow approval. The matching short_name reference list is at `GET /v2/dir/document_types`.

Returns:



59
 
# File 'lib/telnyx/models/dir/phone_number_add_params.rb', line 59

required :document_type, enum: -> { Telnyx::Dir::PhoneNumberAddParams::Document::DocumentType }