Class: Telnyx::Resources::PortingOrders::VerificationCodes

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/porting_orders/verification_codes.rb

Overview

Endpoints related to porting orders management.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ VerificationCodes

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of VerificationCodes.

Parameters:



93
94
95
 
# File 'lib/telnyx/resources/porting_orders/verification_codes.rb', line 93

def initialize(client:)
  @client = client
end

Instance Method Details

#list(id, filter: nil, page_number: nil, page_size: nil, sort: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::PortingOrders::VerificationCodeListResponse>

Returns a list of verification codes for a porting order.

Parameters:

Returns:

See Also:



27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/telnyx/resources/porting_orders/verification_codes.rb', line 27

def list(id, params = {})
  parsed, options = Telnyx::PortingOrders::VerificationCodeListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["porting_orders/%1$s/verification_codes", id],
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Models::PortingOrders::VerificationCodeListResponse,
    options: options
  )
end

#send_(id, phone_numbers: nil, verification_method: nil, request_options: {}) ⇒ nil

Send the verification code for all porting phone numbers.

Parameters:

Returns:

  • (nil)

See Also:



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/telnyx/resources/porting_orders/verification_codes.rb', line 55

def send_(id, params = {})
  parsed, options = Telnyx::PortingOrders::VerificationCodeSendParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["porting_orders/%1$s/verification_codes/send", id],
    body: parsed,
    model: NilClass,
    options: options
  )
end

#verify(id, verification_codes: nil, request_options: {}) ⇒ Telnyx::Models::PortingOrders::VerificationCodeVerifyResponse

Verifies the verification code for a list of phone numbers.

Parameters:

Returns:

See Also:



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/telnyx/resources/porting_orders/verification_codes.rb', line 79

def verify(id, params = {})
  parsed, options = Telnyx::PortingOrders::VerificationCodeVerifyParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["porting_orders/%1$s/verification_codes/verify", id],
    body: parsed,
    model: Telnyx::Models::PortingOrders::VerificationCodeVerifyResponse,
    options: options
  )
end