Class: Zavudev::Resources::Addresses

Inherits:
Object
  • Object
show all
Defined in:
lib/zavudev/resources/addresses.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Addresses

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

Parameters:



101
102
103
 
# File 'lib/zavudev/resources/addresses.rb', line 101

def initialize(client:)
  @client = client
end

Instance Method Details

#create(country_code:, locality:, postal_code:, street_address:, administrative_area: nil, business_name: nil, extended_address: nil, first_name: nil, last_name: nil, request_options: {}) ⇒ Zavudev::Models::AddressCreateResponse

Create a regulatory address for phone number purchases. Some countries require a verified address before phone numbers can be activated.

Parameters:

  • country_code (String)
  • locality (String)
  • postal_code (String)
  • street_address (String)
  • administrative_area (String)
  • business_name (String)
  • extended_address (String)
  • first_name (String)
  • last_name (String)
  • request_options (Zavudev::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/zavudev/resources/addresses.rb', line 25

def create(params)
  parsed, options = Zavudev::AddressCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v1/addresses",
    body: parsed,
    model: Zavudev::Models::AddressCreateResponse,
    options: options
  )
end

#delete(address_id, request_options: {}) ⇒ nil

Delete a regulatory address. Cannot delete addresses that are in use.

Parameters:

Returns:

  • (nil)

See Also:



89
90
91
92
93
94
95
96
 
# File 'lib/zavudev/resources/addresses.rb', line 89

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

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

List regulatory addresses for this project.

Parameters:

Returns:

See Also:



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

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

#retrieve(address_id, request_options: {}) ⇒ Zavudev::Models::AddressRetrieveResponse

Get a specific regulatory address.

Parameters:

Returns:

See Also:



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

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