require "uri" module PureCloud class LocationsApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Get the list of locations. # # @param [Hash] opts the optional parameters # @option opts [String] :state Location state # @option opts [String] :name Location name # @option opts [Integer] :page_size Page size # @option opts [Integer] :page_number Page number # @return [LocationEntityListing] def get(opts = {}) data, status_code, headers = get_with_http_info(opts) return data end # Get the list of locations. # # @param [Hash] opts the optional parameters # @option opts [String] :state Location state # @option opts [String] :name Location name # @option opts [Integer] :page_size Page size # @option opts [Integer] :page_number Page number # @return [Array<(LocationEntityListing, Fixnum, Hash)>] LocationEntityListing data, response status code and response headers def get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: LocationsApi#get ..." end if opts[:'state'] && !['ACTIVE', 'DELETED'].include?(opts[:'state']) fail 'invalid value for "state", must be one of ACTIVE, DELETED' end # resource path path = "/api/v1/locations".sub('{format}','json') # query parameters query_params = {} query_params[:'state'] = opts[:'state'] if opts[:'state'] query_params[:'name'] = opts[:'name'] if opts[:'name'] query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size'] query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number'] # 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, path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'LocationEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: LocationsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get Location by ID. # # @param location_id Location ID # @param [Hash] opts the optional parameters # @return [Location] def get_location(location_id, opts = {}) data, status_code, headers = get_location_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<(Location, Fixnum, Hash)>] Location data, response status code and response headers def get_location_with_http_info(location_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: LocationsApi#get_location ..." end # verify the required parameter 'location_id' is set fail "Missing the required parameter 'location_id' when calling get_location" if location_id.nil? # resource path path = "/api/v1/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, path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Location') if @api_client.config.debugging @api_client.config.logger.debug "API called: LocationsApi#get_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end