class PhoneComClient::PhoneNumbersApi
Attributes
Public Class Methods
# File lib/phone_com_client/api/phone_numbers_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Add a phone number to an account. Add a phone number to an account. See Account Phone Numbers for more info on the properties. @param account_id Account ID @param [Hash] opts the optional parameters @option opts [CreatePhoneNumberParams] :data Phone Number data @return [PhoneNumberFull]
# File lib/phone_com_client/api/phone_numbers_api.rb, line 28 def create_account_phone_number(account_id, opts = {}) data, _status_code, _headers = create_account_phone_number_with_http_info(account_id, opts) data end
Add a phone number to an account. Add a phone number to an account. See Account Phone Numbers for more info on the properties. @param account_id Account ID @param [Hash] opts the optional parameters @option opts [CreatePhoneNumberParams] :data Phone Number data @return [Array<(PhoneNumberFull
, Fixnum, Hash)>] PhoneNumberFull
data, response status code and response headers
# File lib/phone_com_client/api/phone_numbers_api.rb, line 39 def create_account_phone_number_with_http_info(account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.create_account_phone_number ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling PhoneNumbersApi.create_account_phone_number" end # resource path local_var_path = '/accounts/{account_id}/phone-numbers'.sub('{' + 'account_id' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'data']) auth_names = ['apiKey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PhoneNumberFull') if @api_client.config.debugging @api_client.config.logger.debug "API called: PhoneNumbersApi#create_account_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Show details of an individual phone number. Show details of an individual phone number. See Account Phone Numbers for more info on the properties. @param account_id Account ID @param number_id Number ID @param [Hash] opts the optional parameters @return [PhoneNumberFull]
# File lib/phone_com_client/api/phone_numbers_api.rb, line 84 def get_account_phone_number(account_id, number_id, opts = {}) data, _status_code, _headers = get_account_phone_number_with_http_info(account_id, number_id, opts) data end
Show details of an individual phone number. Show details of an individual phone number. See Account Phone Numbers for more info on the properties. @param account_id Account ID @param number_id Number ID @param [Hash] opts the optional parameters @return [Array<(PhoneNumberFull
, Fixnum, Hash)>] PhoneNumberFull
data, response status code and response headers
# File lib/phone_com_client/api/phone_numbers_api.rb, line 95 def get_account_phone_number_with_http_info(account_id, number_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.get_account_phone_number ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling PhoneNumbersApi.get_account_phone_number" end # verify the required parameter 'number_id' is set if @api_client.config.client_side_validation && number_id.nil? fail ArgumentError, "Missing the required parameter 'number_id' when calling PhoneNumbersApi.get_account_phone_number" end # resource path local_var_path = '/accounts/{account_id}/phone-numbers/{number_id}'.sub('{' + 'account_id' + '}', account_id.to_s).sub('{' + 'number_id' + '}', number_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['apiKey'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PhoneNumberFull') if @api_client.config.debugging @api_client.config.logger.debug "API called: PhoneNumbersApi#get_account_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a list of phone numbers registered to an account. Get a list of phone numbers registered to an account. See Account Phone Numbers for more info on the properties. @param account_id Account ID @param [Hash] opts the optional parameters @option opts [Array<String>] :filters_id ID filter @option opts [Array<String>] :filters_name Name filter @option opts [Array<String>] :filters_phone_number Phone number filter @option opts [String] :sort_id ID sorting @option opts [String] :sort_name Name sorting @option opts [String] :sort_phone_number Phone number sorting @option opts [Integer] :limit Max results @option opts [Integer] :offset Results to skip @option opts [String] :fields Field set @return [ListPhoneNumbers]
# File lib/phone_com_client/api/phone_numbers_api.rb, line 152 def list_account_phone_numbers(account_id, opts = {}) data, _status_code, _headers = list_account_phone_numbers_with_http_info(account_id, opts) data end
Get a list of phone numbers registered to an account. Get a list of phone numbers registered to an account. See Account Phone Numbers for more info on the properties. @param account_id Account ID @param [Hash] opts the optional parameters @option opts [Array<String>] :filters_id ID filter @option opts [Array<String>] :filters_name Name filter @option opts [Array<String>] :filters_phone_number Phone number filter @option opts [String] :sort_id ID sorting @option opts [String] :sort_name Name sorting @option opts [String] :sort_phone_number Phone number sorting @option opts [Integer] :limit Max results @option opts [Integer] :offset Results to skip @option opts [String] :fields Field set @return [Array<(ListPhoneNumbers
, Fixnum, Hash)>] ListPhoneNumbers
data, response status code and response headers
# File lib/phone_com_client/api/phone_numbers_api.rb, line 171 def list_account_phone_numbers_with_http_info(account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.list_account_phone_numbers ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling PhoneNumbersApi.list_account_phone_numbers" end if @api_client.config.client_side_validation && !opts[:'sort_id'].nil? && opts[:'sort_id'] !~ Regexp.new(/asc|desc/) fail ArgumentError, "invalid value for 'opts[:\"sort_id\"]' when calling PhoneNumbersApi.list_account_phone_numbers, must conform to the pattern /asc|desc/." end if @api_client.config.client_side_validation && !opts[:'sort_name'].nil? && opts[:'sort_name'] !~ Regexp.new(/asc|desc/) fail ArgumentError, "invalid value for 'opts[:\"sort_name\"]' when calling PhoneNumbersApi.list_account_phone_numbers, must conform to the pattern /asc|desc/." end if @api_client.config.client_side_validation && !opts[:'sort_phone_number'].nil? && opts[:'sort_phone_number'] !~ Regexp.new(/asc|desc/) fail ArgumentError, "invalid value for 'opts[:\"sort_phone_number\"]' when calling PhoneNumbersApi.list_account_phone_numbers, must conform to the pattern /asc|desc/." end # resource path local_var_path = '/accounts/{account_id}/phone-numbers'.sub('{' + 'account_id' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'filters[id]'] = @api_client.build_collection_param(opts[:'filters_id'], :multi) if !opts[:'filters_id'].nil? query_params[:'filters[name]'] = @api_client.build_collection_param(opts[:'filters_name'], :multi) if !opts[:'filters_name'].nil? query_params[:'filters[phone_number]'] = @api_client.build_collection_param(opts[:'filters_phone_number'], :multi) if !opts[:'filters_phone_number'].nil? query_params[:'sort[id]'] = opts[:'sort_id'] if !opts[:'sort_id'].nil? query_params[:'sort[name]'] = opts[:'sort_name'] if !opts[:'sort_name'].nil? query_params[:'sort[phone_number]'] = opts[:'sort_phone_number'] if !opts[:'sort_phone_number'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['apiKey'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ListPhoneNumbers') if @api_client.config.debugging @api_client.config.logger.debug "API called: PhoneNumbersApi#list_account_phone_numbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update the settings for an existing phone number on your account. Update the settings for an existing phone number on your account. See Account Phone Numbers for more info on the properties. @param account_id Account ID @param number_id Number ID @param [Hash] opts the optional parameters @option opts [ReplacePhoneNumberParams] :data Phone Number data @return [PhoneNumberFull]
# File lib/phone_com_client/api/phone_numbers_api.rb, line 238 def replace_account_phone_number(account_id, number_id, opts = {}) data, _status_code, _headers = replace_account_phone_number_with_http_info(account_id, number_id, opts) data end
Update the settings for an existing phone number on your account. Update the settings for an existing phone number on your account. See Account Phone Numbers for more info on the properties. @param account_id Account ID @param number_id Number ID @param [Hash] opts the optional parameters @option opts [ReplacePhoneNumberParams] :data Phone Number data @return [Array<(PhoneNumberFull
, Fixnum, Hash)>] PhoneNumberFull
data, response status code and response headers
# File lib/phone_com_client/api/phone_numbers_api.rb, line 250 def replace_account_phone_number_with_http_info(account_id, number_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.replace_account_phone_number ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling PhoneNumbersApi.replace_account_phone_number" end # verify the required parameter 'number_id' is set if @api_client.config.client_side_validation && number_id.nil? fail ArgumentError, "Missing the required parameter 'number_id' when calling PhoneNumbersApi.replace_account_phone_number" end # resource path local_var_path = '/accounts/{account_id}/phone-numbers/{number_id}'.sub('{' + 'account_id' + '}', account_id.to_s).sub('{' + 'number_id' + '}', number_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'data']) auth_names = ['apiKey'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PhoneNumberFull') if @api_client.config.debugging @api_client.config.logger.debug "API called: PhoneNumbersApi#replace_account_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end