Class: Notifo::EventsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EventsApi

Returns a new instance of EventsApi.



16
17
18
 
# File 'lib/notifo/api/events_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/events_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#events_get_events(app_id, opts = {}) ⇒ ListResponseDtoOfEventDto

Query events.

Parameters:

  • app_id —

    The app where the events belongs to.

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

    the optional parameters

Options Hash (opts):

  • :channels (Array<String>) —

    The active channels.

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



27
28
29
30
 
# File 'lib/notifo/api/events_api.rb', line 27

def events_get_events(app_id, opts = {})
  data, _status_code, _headers = events_get_events_with_http_info(app_id, opts)
  data
end

#events_get_events_with_http_info(app_id, opts = {}) ⇒ Array<(ListResponseDtoOfEventDto, Integer, Hash)>

Query events.

Parameters:

  • app_id —

    The app where the events belongs to.

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

    the optional parameters

Options Hash (opts):

  • :channels (Array<String>) —

    The active channels.

  • :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<(ListResponseDtoOfEventDto, Integer, Hash)>) —

    ListResponseDtoOfEventDto data, response status code and response headers



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
82
83
84
 
# File 'lib/notifo/api/events_api.rb', line 40

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'Channels'] = @api_client.build_collection_param(opts[:'channels'], :multi) if !opts[:'channels'].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] || 'ListResponseDtoOfEventDto' 

  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: EventsApi#events_get_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#events_post_events(body, app_id, opts = {}) ⇒ nil

Publish events.

Parameters:

  • body —

    The publish request.

  • app_id —

    The app where the events belongs to.

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

    the optional parameters

Returns:

  • (nil) 


90
91
92
93
 
# File 'lib/notifo/api/events_api.rb', line 90

def events_post_events(body, app_id, opts = {})
  events_post_events_with_http_info(body, app_id, opts)
  nil
end

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

Publish events.

Parameters:

  • body —

    The publish request.

  • app_id —

    The app where the events belongs to.

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

    the optional parameters

Returns:

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

    nil, 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
145
146
 
# File 'lib/notifo/api/events_api.rb', line 100

def events_post_events_with_http_info(body, app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_post_events ...'
  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 EventsApi.events_post_events"
  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 EventsApi.events_post_events"
  end
  # resource path
  local_var_path = '/api/apps/{appId}/events'.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] 

  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: EventsApi#events_post_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#events_post_my_events(body, opts = {}) ⇒ nil

Publish an event for the current user.

Parameters:

  • body —

    The publish request.

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

    the optional parameters

Returns:

  • (nil) 


151
152
153
154
 
# File 'lib/notifo/api/events_api.rb', line 151

def events_post_my_events(body, opts = {})
  events_post_my_events_with_http_info(body, opts)
  nil
end

#events_post_my_events_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Publish an event for the current user.

Parameters:

  • body —

    The publish request.

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/notifo/api/events_api.rb', line 160

def events_post_my_events_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.events_post_my_events ...'
  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 EventsApi.events_post_my_events"
  end
  # resource path
  local_var_path = '/api/me/events'

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

  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: EventsApi#events_post_my_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end