Class: Svix::StreamEventTypesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/svix/api/stream_event_types_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StreamEventTypesApi

Returns a new instance of StreamEventTypesApi.



19
20
21
 
# File 'lib/svix/api/stream_event_types_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/svix/api/stream_event_types_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#v1_stream_event_type_create(stream_event_type_in, opts = {}) ⇒ StreamEventTypeOut

Create Stream Event Type Create an event type for Streams.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    The request's idempotency key

Returns:



28
29
30
31
 
# File 'lib/svix/api/stream_event_types_api.rb', line 28

def v1_stream_event_type_create(stream_event_type_in, opts = {})
  data, _status_code, _headers = v1_stream_event_type_create_with_http_info(stream_event_type_in, opts)
  data
end

#v1_stream_event_type_create_with_http_info(stream_event_type_in, opts = {}) ⇒ Array<(StreamEventTypeOut, Integer, Hash)>

Create Stream Event Type Create an event type for Streams.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    The request&#39;s idempotency key

Returns:

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

    StreamEventTypeOut data, response status code and response headers



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
 
# File 'lib/svix/api/stream_event_types_api.rb', line 39

def v1_stream_event_type_create_with_http_info(stream_event_type_in, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StreamEventTypesApi.v1_stream_event_type_create ...'
  end
  # verify the required parameter 'stream_event_type_in' is set
  if @api_client.config.client_side_validation && stream_event_type_in.nil?
    fail ArgumentError, "Missing the required parameter 'stream_event_type_in' when calling StreamEventTypesApi.v1_stream_event_type_create"
  end
  # resource path
  local_var_path = '/api/v1/stream/event-type'

  # 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']) unless header_params['Accept']
  # 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
  header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"StreamEventTypesApi.v1_stream_event_type_create",
    :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: StreamEventTypesApi#v1_stream_event_type_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_stream_event_type_delete(name, opts = {}) ⇒ nil

Delete Stream Event Type Delete an event type.

Parameters:

  • name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:

  • (nil) 


98
99
100
101
 
# File 'lib/svix/api/stream_event_types_api.rb', line 98

def v1_stream_event_type_delete(name, opts = {})
  v1_stream_event_type_delete_with_http_info(name, opts)
  nil
end

#v1_stream_event_type_delete_with_http_info(name, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Stream Event Type Delete an event type.

Parameters:

  • name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/svix/api/stream_event_types_api.rb', line 108

def v1_stream_event_type_delete_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StreamEventTypesApi.v1_stream_event_type_delete ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling StreamEventTypesApi.v1_stream_event_type_delete"
  end
  if @api_client.config.client_side_validation && name.to_s.length > 256
    fail ArgumentError, 'invalid value for "name" when calling StreamEventTypesApi.v1_stream_event_type_delete, the character length must be smaller than or equal to 256.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  if @api_client.config.client_side_validation && name !~ pattern
    fail ArgumentError, "invalid value for 'name' when calling StreamEventTypesApi.v1_stream_event_type_delete, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/api/v1/stream/event-type/{name}'.sub('{' + 'name' + '}', CGI.escape(name.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']) unless header_params['Accept']

  # 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] || ['HTTPBearer']

  new_options = opts.merge(
    :operation => :"StreamEventTypesApi.v1_stream_event_type_delete",
    :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: StreamEventTypesApi#v1_stream_event_type_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_stream_event_type_get(name, opts = {}) ⇒ StreamEventTypeOut

Get Stream Event Type Get an event type.

Parameters:

  • name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:



170
171
172
173
 
# File 'lib/svix/api/stream_event_types_api.rb', line 170

def v1_stream_event_type_get(name, opts = {})
  data, _status_code, _headers = v1_stream_event_type_get_with_http_info(name, opts)
  data
end

#v1_stream_event_type_get_with_http_info(name, opts = {}) ⇒ Array<(StreamEventTypeOut, Integer, Hash)>

Get Stream Event Type Get an event type.

Parameters:

  • name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:

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

    StreamEventTypeOut data, response status code and response headers



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
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/svix/api/stream_event_types_api.rb', line 180

def v1_stream_event_type_get_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StreamEventTypesApi.v1_stream_event_type_get ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling StreamEventTypesApi.v1_stream_event_type_get"
  end
  if @api_client.config.client_side_validation && name.to_s.length > 256
    fail ArgumentError, 'invalid value for "name" when calling StreamEventTypesApi.v1_stream_event_type_get, the character length must be smaller than or equal to 256.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  if @api_client.config.client_side_validation && name !~ pattern
    fail ArgumentError, "invalid value for 'name' when calling StreamEventTypesApi.v1_stream_event_type_get, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/api/v1/stream/event-type/{name}'.sub('{' + 'name' + '}', CGI.escape(name.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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"StreamEventTypesApi.v1_stream_event_type_get",
    :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: StreamEventTypesApi#v1_stream_event_type_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_stream_event_type_list(opts = {}) ⇒ ListResponseStreamEventTypeOut

List Stream Event Types List of all the organization’s event types for streaming.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Limit the number of returned items

  • :iterator (String) —

    The iterator returned from a prior invocation

  • :order (Ordering) —

    The sorting order of the returned items

Returns:



244
245
246
247
 
# File 'lib/svix/api/stream_event_types_api.rb', line 244

def v1_stream_event_type_list(opts = {})
  data, _status_code, _headers = v1_stream_event_type_list_with_http_info(opts)
  data
end

#v1_stream_event_type_list_with_http_info(opts = {}) ⇒ Array<(ListResponseStreamEventTypeOut, Integer, Hash)>

List Stream Event Types List of all the organization&#39;s event types for streaming.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Limit the number of returned items

  • :iterator (String) —

    The iterator returned from a prior invocation

  • :order (Ordering) —

    The sorting order of the returned items

Returns:



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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/svix/api/stream_event_types_api.rb', line 256

def v1_stream_event_type_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StreamEventTypesApi.v1_stream_event_type_list ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling StreamEventTypesApi.v1_stream_event_type_list, must be smaller than or equal to 250.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling StreamEventTypesApi.v1_stream_event_type_list, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'iterator'].nil? && opts[:'iterator'].to_s.length > 256
    fail ArgumentError, 'invalid value for "opts[:"iterator"]" when calling StreamEventTypesApi.v1_stream_event_type_list, the character length must be smaller than or equal to 256.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  if @api_client.config.client_side_validation && !opts[:'iterator'].nil? && opts[:'iterator'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"iterator\"]' when calling StreamEventTypesApi.v1_stream_event_type_list, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/api/v1/stream/event-type'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'iterator'] = opts[:'iterator'] if !opts[:'iterator'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"StreamEventTypesApi.v1_stream_event_type_list",
    :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: StreamEventTypesApi#v1_stream_event_type_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_stream_event_type_patch(name, stream_event_type_patch, opts = {}) ⇒ StreamEventTypeOut

Patch Stream Event Type Patch an event type for Streams.

Parameters:

  • name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:



326
327
328
329
 
# File 'lib/svix/api/stream_event_types_api.rb', line 326

def v1_stream_event_type_patch(name, stream_event_type_patch, opts = {})
  data, _status_code, _headers = v1_stream_event_type_patch_with_http_info(name, stream_event_type_patch, opts)
  data
end

#v1_stream_event_type_patch_with_http_info(name, stream_event_type_patch, opts = {}) ⇒ Array<(StreamEventTypeOut, Integer, Hash)>

Patch Stream Event Type Patch an event type for Streams.

Parameters:

  • name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:

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

    StreamEventTypeOut data, response status code and response headers



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/svix/api/stream_event_types_api.rb', line 337

def v1_stream_event_type_patch_with_http_info(name, stream_event_type_patch, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StreamEventTypesApi.v1_stream_event_type_patch ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling StreamEventTypesApi.v1_stream_event_type_patch"
  end
  if @api_client.config.client_side_validation && name.to_s.length > 256
    fail ArgumentError, 'invalid value for "name" when calling StreamEventTypesApi.v1_stream_event_type_patch, the character length must be smaller than or equal to 256.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  if @api_client.config.client_side_validation && name !~ pattern
    fail ArgumentError, "invalid value for 'name' when calling StreamEventTypesApi.v1_stream_event_type_patch, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'stream_event_type_patch' is set
  if @api_client.config.client_side_validation && stream_event_type_patch.nil?
    fail ArgumentError, "Missing the required parameter 'stream_event_type_patch' when calling StreamEventTypesApi.v1_stream_event_type_patch"
  end
  # resource path
  local_var_path = '/api/v1/stream/event-type/{name}'.sub('{' + 'name' + '}', CGI.escape(name.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']) unless header_params['Accept']
  # 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(stream_event_type_patch)

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

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

  new_options = opts.merge(
    :operation => :"StreamEventTypesApi.v1_stream_event_type_patch",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: StreamEventTypesApi#v1_stream_event_type_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_stream_event_type_update(name, stream_event_type_in, opts = {}) ⇒ StreamEventTypeOut

Update Stream Event Type Update or create a event type for Streams.

Parameters:

  • name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:



409
410
411
412
 
# File 'lib/svix/api/stream_event_types_api.rb', line 409

def v1_stream_event_type_update(name, stream_event_type_in, opts = {})
  data, _status_code, _headers = v1_stream_event_type_update_with_http_info(name, stream_event_type_in, opts)
  data
end

#v1_stream_event_type_update_with_http_info(name, stream_event_type_in, opts = {}) ⇒ Array<(StreamEventTypeOut, Integer, Hash)>

Update Stream Event Type Update or create a event type for Streams.

Parameters:

  • name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:

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

    StreamEventTypeOut data, response status code and response headers



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/svix/api/stream_event_types_api.rb', line 420

def v1_stream_event_type_update_with_http_info(name, stream_event_type_in, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StreamEventTypesApi.v1_stream_event_type_update ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling StreamEventTypesApi.v1_stream_event_type_update"
  end
  if @api_client.config.client_side_validation && name.to_s.length > 256
    fail ArgumentError, 'invalid value for "name" when calling StreamEventTypesApi.v1_stream_event_type_update, the character length must be smaller than or equal to 256.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
  if @api_client.config.client_side_validation && name !~ pattern
    fail ArgumentError, "invalid value for 'name' when calling StreamEventTypesApi.v1_stream_event_type_update, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'stream_event_type_in' is set
  if @api_client.config.client_side_validation && stream_event_type_in.nil?
    fail ArgumentError, "Missing the required parameter 'stream_event_type_in' when calling StreamEventTypesApi.v1_stream_event_type_update"
  end
  # resource path
  local_var_path = '/api/v1/stream/event-type/{name}'.sub('{' + 'name' + '}', CGI.escape(name.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']) unless header_params['Accept']
  # 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(stream_event_type_in)

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

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

  new_options = opts.merge(
    :operation => :"StreamEventTypesApi.v1_stream_event_type_update",
    :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: StreamEventTypesApi#v1_stream_event_type_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end