require "uri" module PureCloud class StationsApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Get the list of available stations. # # @param [Hash] opts the optional parameters # @option opts [Integer] :page_size Page size # @option opts [Integer] :page_number Page number # @option opts [String] :sort_by Sort by # @option opts [String] :name Name # @return [StationEntityListing] def get_stations(opts = {}) data, status_code, headers = get_stations_with_http_info(opts) return data end # Get the list of available stations. # # @param [Hash] opts the optional parameters # @option opts [Integer] :page_size Page size # @option opts [Integer] :page_number Page number # @option opts [String] :sort_by Sort by # @option opts [String] :name Name # @return [Array<(StationEntityListing, Fixnum, Hash)>] StationEntityListing data, response status code and response headers def get_stations_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: StationsApi#get_stations ..." end # resource path path = "/api/v1/stations".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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by'] query_params[:'name'] = opts[:'name'] if opts[:'name'] # 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 => 'StationEntityListing') if @api_client.config.debugging @api_client.config.logger.debug "API called: StationsApi#get_stations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get station. # # @param id Station ID # @param [Hash] opts the optional parameters # @return [Station] def get_id(id, opts = {}) data, status_code, headers = get_id_with_http_info(id, opts) return data end # Get station. # # @param id Station ID # @param [Hash] opts the optional parameters # @return [Array<(Station, Fixnum, Hash)>] Station data, response status code and response headers def get_id_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: StationsApi#get_id ..." end # verify the required parameter 'id' is set fail "Missing the required parameter 'id' when calling get_id" if id.nil? # resource path path = "/api/v1/stations/{id}".sub('{format}','json').sub('{' + 'id' + '}', 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 => 'Station') if @api_client.config.debugging @api_client.config.logger.debug "API called: StationsApi#get_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Unassigns the user assigned to this station # # @param id Station ID # @param [Hash] opts the optional parameters # @return [String] def delete_id_associateduser(id, opts = {}) data, status_code, headers = delete_id_associateduser_with_http_info(id, opts) return data end # Unassigns the user assigned to this station # # @param id Station ID # @param [Hash] opts the optional parameters # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers def delete_id_associateduser_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: StationsApi#delete_id_associateduser ..." end # verify the required parameter 'id' is set fail "Missing the required parameter 'id' when calling delete_id_associateduser" if id.nil? # resource path path = "/api/v1/stations/{id}/associateduser".sub('{format}','json').sub('{' + 'id' + '}', 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(:DELETE, path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: StationsApi#delete_id_associateduser\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end