Class: KazooRubySdk::PhoneNumbers

Inherits:

Base

• Object
• Base
• KazooRubySdk::PhoneNumbers

Defined in:

lib/kazoo-ruby-sdk/phone_numbers.rb

Instance Method Summary

• #butch_create(phone_numbers, custom_account_id = nil) ⇒ Hashie::Mash

  Creates list of phone numbers in kazoo for specific account.

• #create(phone_number, custom_account_id = nil, data = {}) ⇒ Hashie::Mash

  Creates phone number in kazoo for specific account.

• #destroy(phone_number, custom_account_id = nil) ⇒ Hashie::Mash

  Delete a specific phone number.

Methods inherited from Base

#account_id, #auth_token, #initialize, #owner_id, #pipe

Methods included from Connection

#pipeline

Constructor Details

This class inherits a constructor from KazooRubySdk::Base

Instance Method Details

#butch_create(phone_numbers, custom_account_id = nil) ⇒ Hashie::Mash

Creates list of phone numbers in kazoo for specific account

Parameters:

• phone_number (Array) —

  list of phone numbers

Returns:

• (Hashie::Mash) —

  response body

# File 'lib/kazoo-ruby-sdk/phone_numbers.rb', line 19

def butch_create(phone_numbers, custom_account_id = nil)
  pipe.put do |request|
    request.url "accounts/#{custom_account_id || account_id}/phone_numbers/collection"
    request.headers['X-Auth-Token'] = auth_token
    request.body = { data: {numbers: phone_numbers} }
  end.body
end

#create(phone_number, custom_account_id = nil, data = {}) ⇒ Hashie::Mash

Creates phone number in kazoo for specific account

Parameters:

• phone_number (String) —

  the phone number

• data (Hash) (defaults to: {}) —

  number’s data. see github.com/2600hz/kazoo/blob/master/applications/crossbar/doc/phone_numbers.md#schema

Returns:

• (Hashie::Mash) —

  response body

# File 'lib/kazoo-ruby-sdk/phone_numbers.rb', line 8

def create(phone_number, custom_account_id = nil, data = {})
  pipe.put do |request|
    request.url "accounts/#{custom_account_id || account_id}/phone_numbers/#{phone_number}"
    request.headers['X-Auth-Token'] = auth_token
    request.body = { data: data }
  end.body
end

#destroy(phone_number, custom_account_id = nil) ⇒ Hashie::Mash

Delete a specific phone number

Parameters:

• phone_number (Array) —

  the phone number

Returns:

• (Hashie::Mash) —

  response body

# File 'lib/kazoo-ruby-sdk/phone_numbers.rb', line 31

def destroy(phone_number, custom_account_id = nil)
  pipe.delete do |request|
    request.url "accounts/#{custom_account_id || account_id}/phone_numbers/#{phone_number}"
    request.headers['X-Auth-Token'] = auth_token
  end.body
end