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_delete_topic(app_id, id, opts = {}) ⇒ nil

Delete a topic.

Parameters:

  • app_id —

    The app where the topics belong to.

  • id —

    The ID of the topic to delete.

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

    the optional parameters

Returns:

  • (nil) 


24
25
26
27
 
# File 'lib/notifo/api/topics_api.rb', line 24

def topics_delete_topic(app_id, id, opts = {})
  topics_delete_topic_with_http_info(app_id, id, opts)
  nil
end

#topics_delete_topic_with_http_info(app_id, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a topic.

Parameters:

  • app_id —

    The app where the topics belong to.

  • id —

    The ID of the topic to delete.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



34
35
36
37
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
 
# File 'lib/notifo/api/topics_api.rb', line 34

def topics_delete_topic_with_http_info(app_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TopicsApi.topics_delete_topic ...'
  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_delete_topic"
  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 TopicsApi.topics_delete_topic"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/topics/{id}'.sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # 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] 

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

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

#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):

  • :scope (TopicQueryScope) —

    The scope of the query.

  • :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:



87
88
89
90
 
# File 'lib/notifo/api/topics_api.rb', line 87

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):

  • :scope (TopicQueryScope) —

    The scope of the query.

  • :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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/notifo/api/topics_api.rb', line 100

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[:'Scope'] = opts[:'scope'] if !opts[:'scope'].nil?
  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

#topics_post_topics(body, app_id, opts = {}) ⇒ Array<TopicDto>

Upsert topics.

Parameters:

  • body —

    The upsert request.

  • app_id —

    The app where the topics belong to.

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

    the optional parameters

Returns:



150
151
152
153
 
# File 'lib/notifo/api/topics_api.rb', line 150

def topics_post_topics(body, app_id, opts = {})
  data, _status_code, _headers = topics_post_topics_with_http_info(body, app_id, opts)
  data
end

#topics_post_topics_with_http_info(body, app_id, opts = {}) ⇒ Array<(Array<TopicDto>, Integer, Hash)>

Upsert topics.

Parameters:

  • body —

    The upsert request.

  • app_id —

    The app where the topics belong to.

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

    the optional parameters

Returns:

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

    Array<TopicDto> data, response status code and response headers



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/notifo/api/topics_api.rb', line 160

def topics_post_topics_with_http_info(body, app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TopicsApi.topics_post_topics ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TopicsApi.topics_post_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_post_topics"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/topics'.sub('{' + 'appId' + '}', app_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[: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 = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'Array<TopicDto>' 

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

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