Class: PhoneComClient::RoutesApi
- Inherits:
-
Object
- Object
- PhoneComClient::RoutesApi
- Defined in:
- lib/phone_com_client/api/routes_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_route(account_id, opts = {}) ⇒ RouteFull
Add a new route to the account.
-
#create_route_with_http_info(account_id, opts = {}) ⇒ Array<(RouteFull, Fixnum, Hash)>
Add a new route to the account.
-
#delete_account_route(account_id, route_id, opts = {}) ⇒ DeleteEntry
Delete a route from the account.
-
#delete_account_route_with_http_info(account_id, route_id, opts = {}) ⇒ Array<(DeleteEntry, Fixnum, Hash)>
Delete a route from the account.
-
#get_account_route(account_id, route_id, opts = {}) ⇒ RouteFull
Show details of an individual route.
-
#get_account_route_with_http_info(account_id, route_id, opts = {}) ⇒ Array<(RouteFull, Fixnum, Hash)>
Show details of an individual route.
-
#initialize(api_client = ApiClient.default) ⇒ RoutesApi
constructor
A new instance of RoutesApi.
-
#list_account_routes(account_id, opts = {}) ⇒ ListRoutes
Get a list of routes for an account.
-
#list_account_routes_with_http_info(account_id, opts = {}) ⇒ Array<(ListRoutes, Fixnum, Hash)>
Get a list of routes for an account.
-
#replace_account_route(account_id, route_id, opts = {}) ⇒ RouteFull
Update the information of a route.
-
#replace_account_route_with_http_info(account_id, route_id, opts = {}) ⇒ Array<(RouteFull, Fixnum, Hash)>
Update the information of a route.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/phone_com_client/api/routes_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_route(account_id, opts = {}) ⇒ RouteFull
Add a new route to the account. Add a new route to the account. See Intro to Routes for more info on the properties.
28 29 30 31 |
# File 'lib/phone_com_client/api/routes_api.rb', line 28 def create_route(account_id, opts = {}) data, _status_code, _headers = create_route_with_http_info(account_id, opts) data end |
#create_route_with_http_info(account_id, opts = {}) ⇒ Array<(RouteFull, Fixnum, Hash)>
Add a new route to the account. Add a new route to the account. See Intro to Routes for more info on the properties.
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/routes_api.rb', line 39 def create_route_with_http_info(account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RoutesApi.create_route ...' 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 RoutesApi.create_route" end # resource path local_var_path = '/accounts/{account_id}/routes'.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 => 'RouteFull') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutesApi#create_route\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_account_route(account_id, route_id, opts = {}) ⇒ DeleteEntry
Delete a route from the account. Delete a route from the account. See Intro to Routes for more info on the properties.
84 85 86 87 |
# File 'lib/phone_com_client/api/routes_api.rb', line 84 def delete_account_route(account_id, route_id, opts = {}) data, _status_code, _headers = delete_account_route_with_http_info(account_id, route_id, opts) data end |
#delete_account_route_with_http_info(account_id, route_id, opts = {}) ⇒ Array<(DeleteEntry, Fixnum, Hash)>
Delete a route from the account. Delete a route from the account. See Intro to Routes for more info on the properties.
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/routes_api.rb', line 95 def delete_account_route_with_http_info(account_id, route_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RoutesApi.delete_account_route ...' 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 RoutesApi.delete_account_route" end # verify the required parameter 'route_id' is set if @api_client.config.client_side_validation && route_id.nil? fail ArgumentError, "Missing the required parameter 'route_id' when calling RoutesApi.delete_account_route" end # resource path local_var_path = '/accounts/{account_id}/routes/{route_id}'.sub('{' + 'account_id' + '}', account_id.to_s).sub('{' + 'route_id' + '}', route_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(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'DeleteEntry') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutesApi#delete_account_route\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_account_route(account_id, route_id, opts = {}) ⇒ RouteFull
Show details of an individual route. Show details of an individual route. See Intro to Routes for more info on the properties.
144 145 146 147 |
# File 'lib/phone_com_client/api/routes_api.rb', line 144 def get_account_route(account_id, route_id, opts = {}) data, _status_code, _headers = get_account_route_with_http_info(account_id, route_id, opts) data end |
#get_account_route_with_http_info(account_id, route_id, opts = {}) ⇒ Array<(RouteFull, Fixnum, Hash)>
Show details of an individual route. Show details of an individual route. See Intro to Routes for more info on the properties.
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 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 |
# File 'lib/phone_com_client/api/routes_api.rb', line 155 def get_account_route_with_http_info(account_id, route_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RoutesApi.get_account_route ...' 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 RoutesApi.get_account_route" end # verify the required parameter 'route_id' is set if @api_client.config.client_side_validation && route_id.nil? fail ArgumentError, "Missing the required parameter 'route_id' when calling RoutesApi.get_account_route" end # resource path local_var_path = '/accounts/{account_id}/routes/{route_id}'.sub('{' + 'account_id' + '}', account_id.to_s).sub('{' + 'route_id' + '}', route_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 => 'RouteFull') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutesApi#get_account_route\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_account_routes(account_id, opts = {}) ⇒ ListRoutes
Get a list of routes for an account. Get a list of routes for an account. See Intro to Routes for more info on the properties.
210 211 212 213 |
# File 'lib/phone_com_client/api/routes_api.rb', line 210 def list_account_routes(account_id, opts = {}) data, _status_code, _headers = list_account_routes_with_http_info(account_id, opts) data end |
#list_account_routes_with_http_info(account_id, opts = {}) ⇒ Array<(ListRoutes, Fixnum, Hash)>
Get a list of routes for an account. Get a list of routes for an account. See Intro to Routes for more info on the properties.
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 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 |
# File 'lib/phone_com_client/api/routes_api.rb', line 227 def list_account_routes_with_http_info(account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RoutesApi.list_account_routes ...' 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 RoutesApi.list_account_routes" 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 RoutesApi.list_account_routes, 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 RoutesApi.list_account_routes, must conform to the pattern /asc|desc/." end # resource path local_var_path = '/accounts/{account_id}/routes'.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[:'sort[id]'] = opts[:'sort_id'] if !opts[:'sort_id'].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 => 'ListRoutes') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutesApi#list_account_routes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#replace_account_route(account_id, route_id, opts = {}) ⇒ RouteFull
Update the information of a route. Update the information of a route. See Intro to Routes for more info on the properties.
288 289 290 291 |
# File 'lib/phone_com_client/api/routes_api.rb', line 288 def replace_account_route(account_id, route_id, opts = {}) data, _status_code, _headers = replace_account_route_with_http_info(account_id, route_id, opts) data end |
#replace_account_route_with_http_info(account_id, route_id, opts = {}) ⇒ Array<(RouteFull, Fixnum, Hash)>
Update the information of a route. Update the information of a route. See Intro to Routes for more info on the properties.
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/phone_com_client/api/routes_api.rb', line 300 def replace_account_route_with_http_info(account_id, route_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RoutesApi.replace_account_route ...' 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 RoutesApi.replace_account_route" end # verify the required parameter 'route_id' is set if @api_client.config.client_side_validation && route_id.nil? fail ArgumentError, "Missing the required parameter 'route_id' when calling RoutesApi.replace_account_route" end # resource path local_var_path = '/accounts/{account_id}/routes/{route_id}'.sub('{' + 'account_id' + '}', account_id.to_s).sub('{' + 'route_id' + '}', route_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 => 'RouteFull') if @api_client.config.debugging @api_client.config.logger.debug "API called: RoutesApi#replace_account_route\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |