Class: Zavudev::Resources::PhoneNumbers

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ PhoneNumbers

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

Parameters:



191
192
193
 
# File 'lib/zavudev/resources/phone_numbers.rb', line 191

def initialize(client:)
  @client = client
end

Instance Method Details

#list(cursor: nil, limit: nil, status: nil, request_options: {}) ⇒ Zavudev::Internal::Cursor<Zavudev::Models::OwnedPhoneNumber>

List all phone numbers owned by this project.

Parameters:

Returns:

See Also:



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/zavudev/resources/phone_numbers.rb', line 66

def list(params = {})
  parsed, options = Zavudev::PhoneNumberListParams.dump_request(params)
  query = Zavudev::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "v1/phone-numbers",
    query: query,
    page: Zavudev::Internal::Cursor,
    model: Zavudev::OwnedPhoneNumber,
    options: options
  )
end

#purchase(phone_number:, name: nil, request_options: {}) ⇒ Zavudev::Models::PhoneNumberPurchaseResponse

Purchase an available phone number. Requires a paid plan: the Free plan cannot purchase phone numbers and receives 402 with code paid_plan_required. Paid plans include one US number at no charge. The included number is one per account and is granted once: claiming it spends the benefit for good, so releasing that number does not make another one free, and numbers the account already bought do not consume it.

Parameters:

  • phone_number (String) —

    Phone number in E.164 format.

  • name (String) —

    Optional custom name for the phone number.

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

Returns:

See Also:



97
98
99
100
101
102
103
104
105
106
 
# File 'lib/zavudev/resources/phone_numbers.rb', line 97

def purchase(params)
  parsed, options = Zavudev::PhoneNumberPurchaseParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v1/phone-numbers",
    body: parsed,
    model: Zavudev::Models::PhoneNumberPurchaseResponse,
    options: options
  )
end

#release(phone_number_id, request_options: {}) ⇒ nil

Release a phone number. The phone number must not be assigned to a sender.

Parameters:

Returns:

  • (nil)

See Also:



118
119
120
121
122
123
124
125
 
# File 'lib/zavudev/resources/phone_numbers.rb', line 118

def release(phone_number_id, params = {})
  @client.request(
    method: :delete,
    path: ["v1/phone-numbers/%1$s", phone_number_id],
    model: NilClass,
    options: params[:request_options]
  )
end

#requirements(country_code:, type: nil, request_options: {}) ⇒ Zavudev::Models::PhoneNumberRequirementsResponse

Get regulatory requirements for purchasing phone numbers in a specific country. Some countries require additional documentation (addresses, identity documents) before phone numbers can be activated.

Parameters:

Returns:

See Also:



142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/zavudev/resources/phone_numbers.rb', line 142

def requirements(params)
  parsed, options = Zavudev::PhoneNumberRequirementsParams.dump_request(params)
  query = Zavudev::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "v1/phone-numbers/requirements",
    query: query.transform_keys(country_code: "countryCode"),
    model: Zavudev::Models::PhoneNumberRequirementsResponse,
    options: options
  )
end

#retrieve(phone_number_id, request_options: {}) ⇒ Zavudev::Models::PhoneNumberRetrieveResponse

Get details of a specific phone number.

Parameters:

Returns:

See Also:



16
17
18
19
20
21
22
23
 
# File 'lib/zavudev/resources/phone_numbers.rb', line 16

def retrieve(phone_number_id, params = {})
  @client.request(
    method: :get,
    path: ["v1/phone-numbers/%1$s", phone_number_id],
    model: Zavudev::Models::PhoneNumberRetrieveResponse,
    options: params[:request_options]
  )
end

#search_available(country_code:, capabilities: nil, contains: nil, limit: nil, type: nil, request_options: {}) ⇒ Zavudev::Models::PhoneNumberSearchAvailableResponse

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

Search for available phone numbers to purchase by country and type.

Parameters:

  • country_code (String) —

    Two-letter ISO country code.

  • capabilities (String) —

    Comma-separated capabilities the number must have: sms, voice, mms. Number

  • contains (String) —

    Search for numbers containing this string.

  • limit (Integer) —

    Maximum number of results to return.

  • type (Symbol, Zavudev::Models::PhoneNumberType) —

    Type of phone number to search for.

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

Returns:

See Also:



176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/zavudev/resources/phone_numbers.rb', line 176

def search_available(params)
  parsed, options = Zavudev::PhoneNumberSearchAvailableParams.dump_request(params)
  query = Zavudev::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "v1/phone-numbers/available",
    query: query.transform_keys(country_code: "countryCode"),
    model: Zavudev::Models::PhoneNumberSearchAvailableResponse,
    options: options
  )
end

#update(phone_number_id, name: nil, sender_id: nil, request_options: {}) ⇒ Zavudev::Models::PhoneNumberUpdateResponse

Update a phone number's name or sender assignment.

Parameters:

  • phone_number_id (String)
  • name (String, nil) —

    Custom name for the phone number. Set to null to clear.

  • sender_id (String, nil) —

    Sender ID to assign the phone number to. Set to null to unassign.

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

Returns:

See Also:



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

def update(phone_number_id, params = {})
  parsed, options = Zavudev::PhoneNumberUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["v1/phone-numbers/%1$s", phone_number_id],
    body: parsed,
    model: Zavudev::Models::PhoneNumberUpdateResponse,
    options: options
  )
end