Class: Telnyx::Resources::NumberReservations

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/number_reservations.rb,
lib/telnyx/resources/number_reservations/actions.rb

Overview

Number reservations

Defined Under Namespace

Classes: Actions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ NumberReservations

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 NumberReservations.

Parameters:



89
90
91
92
 
# File 'lib/telnyx/resources/number_reservations.rb', line 89

def initialize(client:)
  @client = client
  @actions = Telnyx::Resources::NumberReservations::Actions.new(client: client)
end

Instance Attribute Details

#actions ⇒ Telnyx::Resources::NumberReservations::Actions (readonly)

Number reservations

Returns:



9
10
11
 
# File 'lib/telnyx/resources/number_reservations.rb', line 9

def actions
  @actions
end

Instance Method Details

#create(customer_reference: nil, phone_numbers: nil, request_options: {}) ⇒ Telnyx::Models::NumberReservationCreateResponse

Creates a Phone Number Reservation for multiple numbers.

Parameters:

Returns:

See Also:



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/telnyx/resources/number_reservations.rb', line 24

def create(params = {})
  parsed, options = Telnyx::NumberReservationCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "number_reservations",
    body: parsed,
    model: Telnyx::Models::NumberReservationCreateResponse,
    options: options
  )
end

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

Some parameter documentations has been truncated, see Models::NumberReservationListParams for more details.

Gets a paginated list of phone number reservations.

Parameters:

Returns:

See Also:



73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/telnyx/resources/number_reservations.rb', line 73

def list(params = {})
  parsed, options = Telnyx::NumberReservationListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "number_reservations",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::NumberReservation,
    options: options
  )
end

#retrieve(number_reservation_id, request_options: {}) ⇒ Telnyx::Models::NumberReservationRetrieveResponse

Gets a single phone number reservation.

Parameters:

  • number_reservation_id (String) —

    The number reservation ID.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



46
47
48
49
50
51
52
53
 
# File 'lib/telnyx/resources/number_reservations.rb', line 46

def retrieve(number_reservation_id, params = {})
  @client.request(
    method: :get,
    path: ["number_reservations/%1$s", number_reservation_id],
    model: Telnyx::Models::NumberReservationRetrieveResponse,
    options: params[:request_options]
  )
end