Class: Notifo::TopicsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/notifo/api/topics_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TopicsApi

Returns a new instance of TopicsApi.



16
17
18
 
# File 'lib/notifo/api/topics_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/notifo/api/topics_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#topics_get_topics(app_id, opts = {}) ⇒ ListResponseDtoOfTopicDto

Query topics.

Parameters:

  • app_id —

    The app where the topics belongs to.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :query (String) —

    The optional query to search for items.

  • :take (Integer) —

    The number of items to return.

  • :skip (Integer) —

    The number of items to skip.

Returns:



26
27
28
29
 
# File 'lib/notifo/api/topics_api.rb', line 26

def topics_get_topics(app_id, opts = {})
  data, _status_code, _headers = topics_get_topics_with_http_info(app_id, opts)
  data
end

#topics_get_topics_with_http_info(app_id, opts = {}) ⇒ Array<(ListResponseDtoOfTopicDto, Integer, Hash)>

Query topics.

Parameters:

  • app_id —

    The app where the topics belongs to.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :query (String) —

    The optional query to search for items.

  • :take (Integer) —

    The number of items to return.

  • :skip (Integer) —

    The number of items to skip.

Returns:

  • (Array<(ListResponseDtoOfTopicDto, Integer, Hash)>) —

    ListResponseDtoOfTopicDto data, response status code and response headers



38
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
78
79
80
81
 
# File 'lib/notifo/api/topics_api.rb', line 38

def topics_get_topics_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TopicsApi.topics_get_topics ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling TopicsApi.topics_get_topics"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/topics'.sub('{' + 'appId' + '}', app_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'take'] = opts[:'take'] if !opts[:'take'].nil?
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'ListResponseDtoOfTopicDto' 

  auth_names = opts[:auth_names] || []
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TopicsApi#topics_get_topics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end