Class: OryClient::EventsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ory-client/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.



19
20
21
 
# File 'lib/ory-client/api/events_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ory-client/api/events_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_event_stream(project_id, create_event_stream_body, opts = {}) ⇒ EventStream

Create an event stream for your project.

Parameters:

  • project_id (String) —

    Project ID The project's ID.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/ory-client/api/events_api.rb', line 27

def create_event_stream(project_id, create_event_stream_body, opts = {})
  data, _status_code, _headers = create_event_stream_with_http_info(project_id, create_event_stream_body, opts)
  data
end

#create_event_stream_with_http_info(project_id, create_event_stream_body, opts = {}) ⇒ Array<(EventStream, Integer, Hash)>

Create an event stream for your project.

Parameters:

  • project_id (String) —

    Project ID The project&#39;s ID.

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

    the optional parameters

Returns:

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

    EventStream data, response status code and response headers



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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/ory-client/api/events_api.rb', line 37

def create_event_stream_with_http_info(project_id, create_event_stream_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.create_event_stream ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling EventsApi.create_event_stream"
  end
  # verify the required parameter 'create_event_stream_body' is set
  if @api_client.config.client_side_validation && create_event_stream_body.nil?
    fail ArgumentError, "Missing the required parameter 'create_event_stream_body' when calling EventsApi.create_event_stream"
  end
  # resource path
  local_var_path = '/projects/{project_id}/eventstreams'.sub('{' + 'project_id' + '}', CGI.escape(project_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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'EventStream'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oryAccessToken']

  new_options = opts.merge(
    :operation => :"EventsApi.create_event_stream",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsApi#create_event_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_event_stream(project_id, event_stream_id, opts = {}) ⇒ nil

Remove an event stream from a project Remove an event stream from a project.

Parameters:

  • project_id (String) —

    Project ID The project&#39;s ID.

  • event_stream_id (String) —

    Event Stream ID The ID of the event stream to be deleted, as returned when created.

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

    the optional parameters

Returns:

  • (nil) 


100
101
102
103
 
# File 'lib/ory-client/api/events_api.rb', line 100

def delete_event_stream(project_id, event_stream_id, opts = {})
  delete_event_stream_with_http_info(project_id, event_stream_id, opts)
  nil
end

#delete_event_stream_with_http_info(project_id, event_stream_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove an event stream from a project Remove an event stream from a project.

Parameters:

  • project_id (String) —

    Project ID The project&#39;s ID.

  • event_stream_id (String) —

    Event Stream ID The ID of the event stream to be deleted, as returned when created.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/ory-client/api/events_api.rb', line 111

def delete_event_stream_with_http_info(project_id, event_stream_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.delete_event_stream ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling EventsApi.delete_event_stream"
  end
  # verify the required parameter 'event_stream_id' is set
  if @api_client.config.client_side_validation && event_stream_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_stream_id' when calling EventsApi.delete_event_stream"
  end
  # resource path
  local_var_path = '/projects/{project_id}/eventstreams/{event_stream_id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'event_stream_id' + '}', CGI.escape(event_stream_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oryAccessToken']

  new_options = opts.merge(
    :operation => :"EventsApi.delete_event_stream",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsApi#delete_event_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_event_streams(project_id, opts = {}) ⇒ ListEventStreams

List all event streams for the project. This endpoint is not paginated.

Parameters:

  • project_id (String) —

    Project ID The project&#39;s ID.

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

    the optional parameters

Returns:



167
168
169
170
 
# File 'lib/ory-client/api/events_api.rb', line 167

def list_event_streams(project_id, opts = {})
  data, _status_code, _headers = list_event_streams_with_http_info(project_id, opts)
  data
end

#list_event_streams_with_http_info(project_id, opts = {}) ⇒ Array<(ListEventStreams, Integer, Hash)>

List all event streams for the project. This endpoint is not paginated.

Parameters:

  • project_id (String) —

    Project ID The project&#39;s ID.

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

    the optional parameters

Returns:

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

    ListEventStreams data, response status code and response headers



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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/ory-client/api/events_api.rb', line 176

def list_event_streams_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.list_event_streams ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling EventsApi.list_event_streams"
  end
  # resource path
  local_var_path = '/projects/{project_id}/eventstreams'.sub('{' + 'project_id' + '}', CGI.escape(project_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListEventStreams'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oryAccessToken']

  new_options = opts.merge(
    :operation => :"EventsApi.list_event_streams",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsApi#list_event_streams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_event_stream(project_id, event_stream_id, opts = {}) ⇒ EventStream

Update an event stream for a project.

Parameters:

  • project_id (String) —

    Project ID The project&#39;s ID.

  • event_stream_id (String) —

    Event Stream ID The event stream&#39;s ID.

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

    the optional parameters

Options Hash (opts):

Returns:



230
231
232
233
 
# File 'lib/ory-client/api/events_api.rb', line 230

def set_event_stream(project_id, event_stream_id, opts = {})
  data, _status_code, _headers = set_event_stream_with_http_info(project_id, event_stream_id, opts)
  data
end

#set_event_stream_with_http_info(project_id, event_stream_id, opts = {}) ⇒ Array<(EventStream, Integer, Hash)>

Update an event stream for a project.

Parameters:

  • project_id (String) —

    Project ID The project&#39;s ID.

  • event_stream_id (String) —

    Event Stream ID The event stream&#39;s ID.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    EventStream data, response status code and response headers



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/ory-client/api/events_api.rb', line 241

def set_event_stream_with_http_info(project_id, event_stream_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventsApi.set_event_stream ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling EventsApi.set_event_stream"
  end
  # verify the required parameter 'event_stream_id' is set
  if @api_client.config.client_side_validation && event_stream_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_stream_id' when calling EventsApi.set_event_stream"
  end
  # resource path
  local_var_path = '/projects/{project_id}/eventstreams/{event_stream_id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'event_stream_id' + '}', CGI.escape(event_stream_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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'EventStream'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oryAccessToken']

  new_options = opts.merge(
    :operation => :"EventsApi.set_event_stream",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EventsApi#set_event_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end