Class: Telnyx::Resources::DynamicEmergencyAddresses

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/dynamic_emergency_addresses.rb,
sig/telnyx/resources/dynamic_emergency_addresses.rbs

Overview

Dynamic emergency address operations

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ DynamicEmergencyAddresses

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

Parameters:



113
114
115
 
# File 'lib/telnyx/resources/dynamic_emergency_addresses.rb', line 113

def initialize(client:)
  @client = client
end

Instance Method Details

#create(administrative_area:, country_code:, house_number:, locality:, postal_code:, street_name:, extended_address: nil, house_suffix: nil, street_post_directional: nil, street_pre_directional: nil, street_suffix: nil, request_options: {}) ⇒ Telnyx::Models::DynamicEmergencyAddressCreateResponse

Creates a dynamic emergency address, the validated physical location used when provisioning dynamic emergency endpoints.

Parameters:

  • administrative_area (String)
  • country_code (Symbol, Telnyx::Models::DynamicEmergencyAddress::CountryCode)
  • house_number (String)
  • locality (String)
  • postal_code (String)
  • street_name (String)
  • extended_address (String)
  • house_suffix (String)
  • street_post_directional (String)
  • street_pre_directional (String)
  • street_suffix (String)
  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



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

def create(params)
  parsed, options = Telnyx::DynamicEmergencyAddressCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "dynamic_emergency_addresses",
    body: parsed,
    model: Telnyx::Models::DynamicEmergencyAddressCreateResponse,
    options: options
  )
end

#delete(id, request_options: {}) ⇒ Telnyx::Models::DynamicEmergencyAddressDeleteResponse

Deletes the dynamic emergency address based on the ID provided

Parameters:

  • id (String) —

    Dynamic Emergency Address id

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

Returns:

See Also:



101
102
103
104
105
106
107
108
 
# File 'lib/telnyx/resources/dynamic_emergency_addresses.rb', line 101

def delete(id, params = {})
  @client.request(
    method: :delete,
    path: ["dynamic_emergency_addresses/%1$s", id],
    model: Telnyx::Models::DynamicEmergencyAddressDeleteResponse,
    options: params[:request_options]
  )
end

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

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

Returns the dynamic emergency addresses according to filters

Parameters:

Returns:

See Also:



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

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

#retrieve(id, request_options: {}) ⇒ Telnyx::Models::DynamicEmergencyAddressRetrieveResponse

Returns the dynamic emergency address based on the ID provided

Parameters:

  • id (String) —

    Dynamic Emergency Address id

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

Returns:

See Also:



50
51
52
53
54
55
56
57
 
# File 'lib/telnyx/resources/dynamic_emergency_addresses.rb', line 50

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