Class: Telnyx::Resources::NumberOrderPhoneNumbers

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ NumberOrderPhoneNumbers

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

Parameters:



103
104
105
 
# File 'lib/telnyx/resources/number_order_phone_numbers.rb', line 103

def initialize(client:)
  @client = client
end

Instance Method Details

#list(filter: nil, request_options: {}) ⇒ Telnyx::Models::NumberOrderPhoneNumberListResponse

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

Get a list of phone numbers associated to orders.

Parameters:

Returns:

See Also:



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/telnyx/resources/number_order_phone_numbers.rb', line 40

def list(params = {})
  parsed, options = Telnyx::NumberOrderPhoneNumberListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "number_order_phone_numbers",
    query: query,
    model: Telnyx::Models::NumberOrderPhoneNumberListResponse,
    options: options
  )
end

#retrieve(number_order_phone_number_id, request_options: {}) ⇒ Telnyx::Models::NumberOrderPhoneNumberRetrieveResponse

Get an existing phone number in number order.

Parameters:

  • number_order_phone_number_id (String) —

    The number order phone number ID.

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

Returns:

See Also:



17
18
19
20
21
22
23
24
 
# File 'lib/telnyx/resources/number_order_phone_numbers.rb', line 17

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

#update_requirement_group(id, requirement_group_id:, request_options: {}) ⇒ Telnyx::Models::NumberOrderPhoneNumberUpdateRequirementGroupResponse

Update requirement group for a phone number order

Parameters:

  • id (String) —

    The unique identifier of the number order phone number

  • requirement_group_id (String) —

    The ID of the requirement group to associate

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

Returns:

See Also:



65
66
67
68
69
70
71
72
73
74
 
# File 'lib/telnyx/resources/number_order_phone_numbers.rb', line 65

def update_requirement_group(id, params)
  parsed, options = Telnyx::NumberOrderPhoneNumberUpdateRequirementGroupParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["number_order_phone_numbers/%1$s/requirement_group", id],
    body: parsed,
    model: Telnyx::Models::NumberOrderPhoneNumberUpdateRequirementGroupResponse,
    options: options
  )
end

#update_requirements(number_order_phone_number_id, regulatory_requirements: nil, request_options: {}) ⇒ Telnyx::Models::NumberOrderPhoneNumberUpdateRequirementsResponse

Updates requirements for a single phone number within a number order.

Parameters:

Returns:

See Also:



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/telnyx/resources/number_order_phone_numbers.rb', line 89

def update_requirements(number_order_phone_number_id, params = {})
  parsed, options = Telnyx::NumberOrderPhoneNumberUpdateRequirementsParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["number_order_phone_numbers/%1$s", number_order_phone_number_id],
    body: parsed,
    model: Telnyx::Models::NumberOrderPhoneNumberUpdateRequirementsResponse,
    options: options
  )
end