class RadioManagerClient::StoryApi
Attributes
Public Class Methods
# File lib/radiomanager_client/api/story_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create story. Create story. @param data Data
**(Required)** @param [Hash] opts the optional parameters @return [PostSuccess]
# File lib/radiomanager_client/api/story_api.rb, line 28 def create_story(data, opts = {}) data, _status_code, _headers = create_story_with_http_info(data, opts) return data end
Create story. Create story. @param data Data
**(Required)** @param [Hash] opts the optional parameters @return [Array<(PostSuccess
, Fixnum, Hash)>] PostSuccess
data, response status code and response headers
# File lib/radiomanager_client/api/story_api.rb, line 38 def create_story_with_http_info(data, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: StoryApi.create_story ..." end # verify the required parameter 'data' is set if @api_client.config.client_side_validation && data.nil? fail ArgumentError, "Missing the required parameter 'data' when calling StoryApi.create_story" end # resource path local_var_path = "/stories" # 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(data) auth_names = ['API Key'] 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 => 'PostSuccess') if @api_client.config.debugging @api_client.config.logger.debug "API called: StoryApi#create_story\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete story by id Delete story by id @param id ID of Story
**(Required)** @param [Hash] opts the optional parameters @return [Success]
# File lib/radiomanager_client/api/story_api.rb, line 83 def delete_story_by_id(id, opts = {}) data, _status_code, _headers = delete_story_by_id_with_http_info(id, opts) return data end
Delete story by id Delete story by id @param id ID of Story
**(Required)** @param [Hash] opts the optional parameters @return [Array<(Success
, Fixnum, Hash)>] Success
data, response status code and response headers
# File lib/radiomanager_client/api/story_api.rb, line 93 def delete_story_by_id_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: StoryApi.delete_story_by_id ..." end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling StoryApi.delete_story_by_id" end if @api_client.config.client_side_validation && id < 0 fail ArgumentError, 'invalid value for "id" when calling StoryApi.delete_story_by_id, must be greater than or equal to 0.' end # resource path local_var_path = "/stories/{id}".sub('{' + 'id' + '}', 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 = ['API Key'] 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 => 'Success') if @api_client.config.debugging @api_client.config.logger.debug "API called: StoryApi#delete_story_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get story by id Get story by id @param id ID of Story
**(Required)** @param [Hash] opts the optional parameters @option opts [Integer] :_external_station_id Query on a different (content providing) station *(Optional)* @return [StoryResult]
# File lib/radiomanager_client/api/story_api.rb, line 143 def get_story_by_id(id, opts = {}) data, _status_code, _headers = get_story_by_id_with_http_info(id, opts) return data end
Get story by id Get story by id @param id ID of Story
**(Required)** @param [Hash] opts the optional parameters @option opts [Integer] :_external_station_id Query on a different (content providing) station *(Optional)* @return [Array<(StoryResult
, Fixnum, Hash)>] StoryResult
data, response status code and response headers
# File lib/radiomanager_client/api/story_api.rb, line 154 def get_story_by_id_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: StoryApi.get_story_by_id ..." end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling StoryApi.get_story_by_id" end if @api_client.config.client_side_validation && id < 0 fail ArgumentError, 'invalid value for "id" when calling StoryApi.get_story_by_id, must be greater than or equal to 0.' end # resource path local_var_path = "/stories/{id}".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} query_params[:'_external_station_id'] = opts[:'_external_station_id'] if !opts[:'_external_station_id'].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 = ['API Key'] 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 => 'StoryResult') if @api_client.config.debugging @api_client.config.logger.debug "API called: StoryApi#get_story_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get all stories. List all stories. @param [Hash] opts the optional parameters @option opts [Integer] :page Current page *(Optional)* (default to 1) @option opts [Integer] :item_id Search on Item
ID *(Optional)* `(Relation)` @option opts [Integer] :model_type_id Search on ModelType
ID *(Optional)* `(Relation)` @option opts [Integer] :tag_id Search on Tag
ID *(Optional)* `(Relation)` @option opts [Integer] :limit Results per page *(Optional)* @option opts [String] :order_by Field to order the results *(Optional)* @option opts [String] :order_direction Direction of ordering *(Optional)* @option opts [Integer] :_external_station_id Query on a different (content providing) station *(Optional)* @return [StoryResults]
# File lib/radiomanager_client/api/story_api.rb, line 211 def list_stories(opts = {}) data, _status_code, _headers = list_stories_with_http_info(opts) return data end
Get all stories. List all stories. @param [Hash] opts the optional parameters @option opts [Integer] :page Current page *(Optional)* @option opts [Integer] :item_id Search on Item
ID *(Optional)* `(Relation)` @option opts [Integer] :model_type_id Search on ModelType
ID *(Optional)* `(Relation)` @option opts [Integer] :tag_id Search on Tag
ID *(Optional)* `(Relation)` @option opts [Integer] :limit Results per page *(Optional)* @option opts [String] :order_by Field to order the results *(Optional)* @option opts [String] :order_direction Direction of ordering *(Optional)* @option opts [Integer] :_external_station_id Query on a different (content providing) station *(Optional)* @return [Array<(StoryResults
, Fixnum, Hash)>] StoryResults
data, response status code and response headers
# File lib/radiomanager_client/api/story_api.rb, line 228 def list_stories_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: StoryApi.list_stories ..." end if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0 fail ArgumentError, 'invalid value for "opts[:"page"]" when calling StoryApi.list_stories, must be greater than or equal to 0.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 50 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling StoryApi.list_stories, must be smaller than or equal to 50.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling StoryApi.list_stories, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && opts[:'order_direction'] && !['asc', 'desc'].include?(opts[:'order_direction']) fail ArgumentError, 'invalid value for "order_direction", must be one of asc, desc' end # resource path local_var_path = "/stories" # query parameters query_params = {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'item_id'] = opts[:'item_id'] if !opts[:'item_id'].nil? query_params[:'model_type_id'] = opts[:'model_type_id'] if !opts[:'model_type_id'].nil? query_params[:'tag_id'] = opts[:'tag_id'] if !opts[:'tag_id'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'order-by'] = opts[:'order_by'] if !opts[:'order_by'].nil? query_params[:'order-direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil? query_params[:'_external_station_id'] = opts[:'_external_station_id'] if !opts[:'_external_station_id'].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 = ['API Key'] 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 => 'StoryResults') if @api_client.config.debugging @api_client.config.logger.debug "API called: StoryApi#list_stories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update story by id Update story by id @param id ID of Story
**(Required)** @param [Hash] opts the optional parameters @option opts [StoryDataInput] :data Data
*(Optional)* @return [Success]
# File lib/radiomanager_client/api/story_api.rb, line 293 def update_story_by_id(id, opts = {}) data, _status_code, _headers = update_story_by_id_with_http_info(id, opts) return data end
Update story by id Update story by id @param id ID of Story
**(Required)** @param [Hash] opts the optional parameters @option opts [StoryDataInput] :data Data
*(Optional)* @return [Array<(Success
, Fixnum, Hash)>] Success
data, response status code and response headers
# File lib/radiomanager_client/api/story_api.rb, line 304 def update_story_by_id_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: StoryApi.update_story_by_id ..." end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling StoryApi.update_story_by_id" end if @api_client.config.client_side_validation && id < 0 fail ArgumentError, 'invalid value for "id" when calling StoryApi.update_story_by_id, must be greater than or equal to 0.' end # resource path local_var_path = "/stories/{id}".sub('{' + 'id' + '}', 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 = ['API Key'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Success') if @api_client.config.debugging @api_client.config.logger.debug "API called: StoryApi#update_story_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end