Class: SevenApi::Resources::Numbers

Inherits:
SevenApi::Resource show all
Defined in:
lib/seven_api/resources/numbers.rb

Constant Summary

Constants inherited from SevenApi::Resource

SevenApi::Resource::BASE_PATH

Instance Attribute Summary

Attributes inherited from SevenApi::Resource

#api_key, #builder, #conn, #endpoint, #http_methods, #request_methods, #sent_with

Instance Method Summary collapse

Methods inherited from SevenApi::Resource

get_endpoint, get_http_methods, #initialize

Constructor Details

This class inherits a constructor from SevenApi::Resource

Instance Method Details

#active ⇒ Array

Retrieve active phone numbers read more: docs.seven.io/en/rest-api/endpoints/numbers#active-numbers

Returns:

  • (Array) 


21
22
23
 
# File 'lib/seven_api/resources/numbers.rb', line 21

def active
  request(:get, {}, {}, '/active')
end

#available ⇒ Hash

Retrieve available phone numbers read more: docs.seven.io/en/rest-api/endpoints/numbers#available-numbers

Returns:

  • (Hash) 


29
30
31
 
# File 'lib/seven_api/resources/numbers.rb', line 29

def available
  request(:get, params, {}, '/available')
end

#delete(number, delete_immediately = false) ⇒ Hash

Delete a number read more: docs.seven.io/en/rest-api/endpoints/numbers#delete-number

Parameters:

  • number (String)

Returns:

  • (Hash) 


50
51
52
 
# File 'lib/seven_api/resources/numbers.rb', line 50

def delete(number, delete_immediately = false)
  request(:delete, {}, {delete_immediately => delete_immediately}, "/active/#{number}")
end

#one(number) ⇒ Hash

Retrieve a number read more: docs.seven.io/en/rest-api/endpoints/numbers#get-number

Parameters:

  • number (String)

Returns:

  • (Hash) 


58
59
60
 
# File 'lib/seven_api/resources/numbers.rb', line 58

def one(number)
  request(:get, {}, {}, "/active/#{number}")
end

#order(number, payment_interval = PaymentInterval.ASCENDING) ⇒ Hash

Order a phone number read more: docs.seven.io/en/rest-api/endpoints/numbers#order-a-number

Parameters:

  • number (String)
  • payment_interval (String) (defaults to: PaymentInterval.ASCENDING)

Returns:

  • (Hash) 


38
39
40
41
42
43
44
 
# File 'lib/seven_api/resources/numbers.rb', line 38

def order(number, payment_interval = PaymentInterval.ASCENDING)
  payload = {
    number => number,
    payment_interval => payment_interval,
  }
  request(:post, payload, {}, '/order')
end

#update(number, params) ⇒ Hash

Update a number read more: docs.seven.io/en/rest-api/endpoints/numbers#update-number

Parameters:

  • number (String)
  • params (Hash)

Returns:

  • (Hash) 


67
68
69
 
# File 'lib/seven_api/resources/numbers.rb', line 67

def update(number, params)
  request(:patch, params, {}, "/active/#{number}")
end