class PureCloud::LocationsApi
Attributes
Public Class Methods
# File lib/purecloud/api/locations_api.rb, line 23 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get Location
by ID.
@param location_id Location
ID @param [Hash] opts the optional parameters @return [LocationDefinition]
# File lib/purecloud/api/locations_api.rb, line 32 def get_location_id(location_id, opts = {}) data, status_code, headers = get_location_id_with_http_info(location_id, opts) return data end
Get Location
by ID.
@param location_id Location
ID @param [Hash] opts the optional parameters @return [Array<(LocationDefinition
, Fixnum, Hash)>] LocationDefinition
data, response status code and response headers
# File lib/purecloud/api/locations_api.rb, line 42 def get_location_id_with_http_info(location_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: LocationsApi#get_location_id ..." end # verify the required parameter 'location_id' is set fail "Missing the required parameter 'location_id' when calling get_location_id" if location_id.nil? # resource path local_var_path = "/api/v2/locations/{locationId}".sub('{format}','json').sub('{' + 'locationId' + '}', location_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'LocationDefinition') if @api_client.config.debugging @api_client.config.logger.debug "API called: LocationsApi#get_location_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a list of all locations.
@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page
size (default to 25) @option opts [Integer] :page_number Page
number (default to 1) @option opts [String] :sort_order Sort order @return [Array<LocationDefinition>]
# File lib/purecloud/api/locations_api.rb, line 94 def get_locations(opts = {}) data, status_code, headers = get_locations_with_http_info(opts) return data end
Get a list of all locations.
@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page
size @option opts [Integer] :page_number Page
number @option opts [String] :sort_order Sort order @return [Array<(Array<LocationDefinition>, Fixnum, Hash)>] Array<LocationDefinition> data, response status code and response headers
# File lib/purecloud/api/locations_api.rb, line 106 def get_locations_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: LocationsApi#get_locations ..." end if opts[:'sort_order'] && !['asc', 'desc'].include?(opts[:'sort_order']) fail 'invalid value for "sort_order", must be one of asc, desc' end # resource path local_var_path = "/api/v2/locations".sub('{format}','json') # query parameters query_params = {} query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number'] query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'Array<LocationDefinition>') if @api_client.config.debugging @api_client.config.logger.debug "API called: LocationsApi#get_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search locations using the q64 value returned from a previous search
@param q64 q64 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand expand @return [LocationsSearchResponse]
# File lib/purecloud/api/locations_api.rb, line 161 def get_search(q64, opts = {}) data, status_code, headers = get_search_with_http_info(q64, opts) return data end
Search locations using the q64 value returned from a previous search
@param q64 q64 @param [Hash] opts the optional parameters @option opts [Array<String>] :expand expand @return [Array<(LocationsSearchResponse
, Fixnum, Hash)>] LocationsSearchResponse
data, response status code and response headers
# File lib/purecloud/api/locations_api.rb, line 172 def get_search_with_http_info(q64, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: LocationsApi#get_search ..." end # verify the required parameter 'q64' is set fail "Missing the required parameter 'q64' when calling get_search" if q64.nil? # resource path local_var_path = "/api/v2/locations/search".sub('{format}','json') # query parameters query_params = {} query_params[:'q64'] = q64 query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] 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 => 'LocationsSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: LocationsApi#get_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search locations
@param body Search request options @param [Hash] opts the optional parameters @return [LocationsSearchResponse]
# File lib/purecloud/api/locations_api.rb, line 224 def post_search(body, opts = {}) data, status_code, headers = post_search_with_http_info(body, opts) return data end
Search locations
@param body Search request options @param [Hash] opts the optional parameters @return [Array<(LocationsSearchResponse
, Fixnum, Hash)>] LocationsSearchResponse
data, response status code and response headers
# File lib/purecloud/api/locations_api.rb, line 234 def post_search_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: LocationsApi#post_search ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_search" if body.nil? # resource path local_var_path = "/api/v2/locations/search".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] 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 => 'LocationsSearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: LocationsApi#post_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end