Class: PhoneComClient::ExtensionsApi
- Inherits:
-
Object
- Object
- PhoneComClient::ExtensionsApi
- Defined in:
- lib/phone_com_client/api/extensions_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_account_extension(account_id, opts = {}) ⇒ ExtensionFull
Create an individual extension.
-
#create_account_extension_with_http_info(account_id, opts = {}) ⇒ Array<(ExtensionFull, Fixnum, Hash)>
Create an individual extension.
-
#get_account_extension(account_id, extension_id, opts = {}) ⇒ ExtensionFull
Show details of an individual extension.
-
#get_account_extension_with_http_info(account_id, extension_id, opts = {}) ⇒ Array<(ExtensionFull, Fixnum, Hash)>
Show details of an individual extension.
-
#initialize(api_client = ApiClient.default) ⇒ ExtensionsApi
constructor
A new instance of ExtensionsApi.
-
#list_account_extensions(account_id, opts = {}) ⇒ ListExtensions
Get a list of extensions visible to the authenticated user or client.
-
#list_account_extensions_with_http_info(account_id, opts = {}) ⇒ Array<(ListExtensions, Fixnum, Hash)>
Get a list of extensions visible to the authenticated user or client.
-
#replace_account_extension(account_id, extension_id, opts = {}) ⇒ ExtensionFull
Replace an individual extension.
-
#replace_account_extension_with_http_info(account_id, extension_id, opts = {}) ⇒ Array<(ExtensionFull, Fixnum, Hash)>
Replace an individual extension.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ExtensionsApi
Returns a new instance of ExtensionsApi.
19 20 21 |
# File 'lib/phone_com_client/api/extensions_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/phone_com_client/api/extensions_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_account_extension(account_id, opts = {}) ⇒ ExtensionFull
Create an individual extension. Create an individual extension. See extension for more details.
28 29 30 31 |
# File 'lib/phone_com_client/api/extensions_api.rb', line 28 def create_account_extension(account_id, opts = {}) data, _status_code, _headers = create_account_extension_with_http_info(account_id, opts) data end |
#create_account_extension_with_http_info(account_id, opts = {}) ⇒ Array<(ExtensionFull, Fixnum, Hash)>
Create an individual extension. Create an individual extension. See extension for more details.
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/phone_com_client/api/extensions_api.rb', line 39 def create_account_extension_with_http_info(account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ExtensionsApi.create_account_extension ...' 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 ExtensionsApi.create_account_extension" end # resource path local_var_path = '/accounts/{account_id}/extensions'.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 => 'ExtensionFull') if @api_client.config.debugging @api_client.config.logger.debug "API called: ExtensionsApi#create_account_extension\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_account_extension(account_id, extension_id, opts = {}) ⇒ ExtensionFull
Show details of an individual extension. Show details of an individual extension. See extension for more details.
84 85 86 87 |
# File 'lib/phone_com_client/api/extensions_api.rb', line 84 def get_account_extension(account_id, extension_id, opts = {}) data, _status_code, _headers = get_account_extension_with_http_info(account_id, extension_id, opts) data end |
#get_account_extension_with_http_info(account_id, extension_id, opts = {}) ⇒ Array<(ExtensionFull, Fixnum, Hash)>
Show details of an individual extension. Show details of an individual extension. See extension for more details.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/phone_com_client/api/extensions_api.rb', line 95 def get_account_extension_with_http_info(account_id, extension_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ExtensionsApi.get_account_extension ...' 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 ExtensionsApi.get_account_extension" end # verify the required parameter 'extension_id' is set if @api_client.config.client_side_validation && extension_id.nil? fail ArgumentError, "Missing the required parameter 'extension_id' when calling ExtensionsApi.get_account_extension" end # resource path local_var_path = '/accounts/{account_id}/extensions/{extension_id}'.sub('{' + 'account_id' + '}', account_id.to_s).sub('{' + 'extension_id' + '}', extension_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 => 'ExtensionFull') if @api_client.config.debugging @api_client.config.logger.debug "API called: ExtensionsApi#get_account_extension\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_account_extensions(account_id, opts = {}) ⇒ ListExtensions
Get a list of extensions visible to the authenticated user or client. Get a list of extensions visible to the authenticated user or client. See extension for more details.
152 153 154 155 |
# File 'lib/phone_com_client/api/extensions_api.rb', line 152 def list_account_extensions(account_id, opts = {}) data, _status_code, _headers = list_account_extensions_with_http_info(account_id, opts) data end |
#list_account_extensions_with_http_info(account_id, opts = {}) ⇒ Array<(ListExtensions, Fixnum, Hash)>
Get a list of extensions visible to the authenticated user or client. Get a list of extensions visible to the authenticated user or client. See extension for more details.
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/phone_com_client/api/extensions_api.rb', line 171 def list_account_extensions_with_http_info(account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ExtensionsApi.list_account_extensions ...' 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 ExtensionsApi.list_account_extensions" 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 ExtensionsApi.list_account_extensions, must conform to the pattern /asc|desc/." end if @api_client.config.client_side_validation && !opts[:'sort_extension'].nil? && opts[:'sort_extension'] !~ Regexp.new(/asc|desc/) fail ArgumentError, "invalid value for 'opts[:\"sort_extension\"]' when calling ExtensionsApi.list_account_extensions, 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 ExtensionsApi.list_account_extensions, must conform to the pattern /asc|desc/." end # resource path local_var_path = '/accounts/{account_id}/extensions'.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[extension]'] = @api_client.build_collection_param(opts[:'filters_extension'], :multi) if !opts[:'filters_extension'].nil? query_params[:'filters[name]'] = @api_client.build_collection_param(opts[:'filters_name'], :multi) if !opts[:'filters_name'].nil? query_params[:'sort[id]'] = opts[:'sort_id'] if !opts[:'sort_id'].nil? query_params[:'sort[extension]'] = opts[:'sort_extension'] if !opts[:'sort_extension'].nil? query_params[:'sort[name]'] = opts[:'sort_name'] if !opts[:'sort_name'].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 => 'ListExtensions') if @api_client.config.debugging @api_client.config.logger.debug "API called: ExtensionsApi#list_account_extensions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#replace_account_extension(account_id, extension_id, opts = {}) ⇒ ExtensionFull
Replace an individual extension. Replace an individual extension. See extension for more details.
238 239 240 241 |
# File 'lib/phone_com_client/api/extensions_api.rb', line 238 def replace_account_extension(account_id, extension_id, opts = {}) data, _status_code, _headers = replace_account_extension_with_http_info(account_id, extension_id, opts) data end |
#replace_account_extension_with_http_info(account_id, extension_id, opts = {}) ⇒ Array<(ExtensionFull, Fixnum, Hash)>
Replace an individual extension. Replace an individual extension. See extension for more details.
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/phone_com_client/api/extensions_api.rb', line 250 def replace_account_extension_with_http_info(account_id, extension_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ExtensionsApi.replace_account_extension ...' 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 ExtensionsApi.replace_account_extension" end # verify the required parameter 'extension_id' is set if @api_client.config.client_side_validation && extension_id.nil? fail ArgumentError, "Missing the required parameter 'extension_id' when calling ExtensionsApi.replace_account_extension" end # resource path local_var_path = '/accounts/{account_id}/extensions/{extension_id}'.sub('{' + 'account_id' + '}', account_id.to_s).sub('{' + 'extension_id' + '}', extension_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 => 'ExtensionFull') if @api_client.config.debugging @api_client.config.logger.debug "API called: ExtensionsApi#replace_account_extension\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |