Class: Svix::StreamApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StreamApi

Returns a new instance of StreamApi.



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

def api_client
  @api_client
end

Instance Method Details

#v1_stream_create(stream_in, opts = {}) ⇒ StreamOut

Create Stream Creates a new stream.

Parameters:

  • stream_in (StreamIn)
  • 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_api.rb', line 28

def v1_stream_create(stream_in, opts = {})
  data, _status_code, _headers = v1_stream_create_with_http_info(stream_in, opts)
  data
end

#v1_stream_create_events(stream_id, create_stream_in, opts = {}) ⇒ Object

Create Events Creates events on the Stream.

Parameters:

  • stream_id (String)
  • create_stream_in (CreateStreamIn)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    The request's idempotency key

Returns:

  • (Object) 


100
101
102
103
 
# File 'lib/svix/api/stream_api.rb', line 100

def v1_stream_create_events(stream_id, create_stream_in, opts = {})
  data, _status_code, _headers = v1_stream_create_events_with_http_info(stream_id, create_stream_in, opts)
  data
end

#v1_stream_create_events_with_http_info(stream_id, create_stream_in, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Create Events Creates events on the Stream.

Parameters:

  • stream_id (String)
  • create_stream_in (CreateStreamIn)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    The request&#39;s idempotency key

Returns:

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

    Object data, response status code and response headers



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
164
165
166
167
168
 
# File 'lib/svix/api/stream_api.rb', line 112

def v1_stream_create_events_with_http_info(stream_id, create_stream_in, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StreamApi.v1_stream_create_events ...'
  end
  # verify the required parameter 'stream_id' is set
  if @api_client.config.client_side_validation && stream_id.nil?
    fail ArgumentError, "Missing the required parameter 'stream_id' when calling StreamApi.v1_stream_create_events"
  end
  # verify the required parameter 'create_stream_in' is set
  if @api_client.config.client_side_validation && create_stream_in.nil?
    fail ArgumentError, "Missing the required parameter 'create_stream_in' when calling StreamApi.v1_stream_create_events"
  end
  # resource path
  local_var_path = '/api/v1/stream/{stream_id}/events'.sub('{' + 'stream_id' + '}', CGI.escape(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']) 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(create_stream_in)

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

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

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

#v1_stream_create_with_http_info(stream_in, opts = {}) ⇒ Array<(StreamOut, Integer, Hash)>

Create Stream Creates a new stream.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    The request&#39;s idempotency key

Returns:

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

    StreamOut 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_api.rb', line 39

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

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

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

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

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

#v1_stream_delete(stream_id, opts = {}) ⇒ nil

Delete Stream Delete a stream.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


175
176
177
178
 
# File 'lib/svix/api/stream_api.rb', line 175

def v1_stream_delete(stream_id, opts = {})
  v1_stream_delete_with_http_info(stream_id, opts)
  nil
end

#v1_stream_delete_with_http_info(stream_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Stream Delete a stream.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def v1_stream_delete_with_http_info(stream_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StreamApi.v1_stream_delete ...'
  end
  # verify the required parameter 'stream_id' is set
  if @api_client.config.client_side_validation && stream_id.nil?
    fail ArgumentError, "Missing the required parameter 'stream_id' when calling StreamApi.v1_stream_delete"
  end
  # resource path
  local_var_path = '/api/v1/stream/{stream_id}'.sub('{' + 'stream_id' + '}', CGI.escape(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']) 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 => :"StreamApi.v1_stream_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: StreamApi#v1_stream_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_stream_events_get(stream_id, opts = {}) ⇒ EventStreamOut

Stream Events Iterate over a stream of events.

Parameters:

  • stream_id (String)
  • 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

  • :after (Time)

Returns:



241
242
243
244
 
# File 'lib/svix/api/stream_api.rb', line 241

def v1_stream_events_get(stream_id, opts = {})
  data, _status_code, _headers = v1_stream_events_get_with_http_info(stream_id, opts)
  data
end

#v1_stream_events_get_with_http_info(stream_id, opts = {}) ⇒ Array<(EventStreamOut, Integer, Hash)>

Stream Events Iterate over a stream of events.

Parameters:

  • stream_id (String)
  • 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

  • :after (Time)

Returns:

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

    EventStreamOut data, response status code and response headers



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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/svix/api/stream_api.rb', line 254

def v1_stream_events_get_with_http_info(stream_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StreamApi.v1_stream_events_get ...'
  end
  # verify the required parameter 'stream_id' is set
  if @api_client.config.client_side_validation && stream_id.nil?
    fail ArgumentError, "Missing the required parameter 'stream_id' when calling StreamApi.v1_stream_events_get"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling StreamApi.v1_stream_events_get, 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 StreamApi.v1_stream_events_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/v1/stream/{stream_id}/events'.sub('{' + 'stream_id' + '}', CGI.escape(stream_id.to_s))

  # 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[:'after'] = opts[:'after'] if !opts[:'after'].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] || 'EventStreamOut'

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

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

#v1_stream_get(stream_id, opts = {}) ⇒ StreamOut

Get Stream Get a stream by id or uid.

Parameters:

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

    the optional parameters

Returns:



318
319
320
321
 
# File 'lib/svix/api/stream_api.rb', line 318

def v1_stream_get(stream_id, opts = {})
  data, _status_code, _headers = v1_stream_get_with_http_info(stream_id, opts)
  data
end

#v1_stream_get_with_http_info(stream_id, opts = {}) ⇒ Array<(StreamOut, Integer, Hash)>

Get Stream Get a stream by id or uid.

Parameters:

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

    the optional parameters

Returns:

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

    StreamOut data, response status code and response headers



328
329
330
331
332
333
334
335
336
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
 
# File 'lib/svix/api/stream_api.rb', line 328

def v1_stream_get_with_http_info(stream_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StreamApi.v1_stream_get ...'
  end
  # verify the required parameter 'stream_id' is set
  if @api_client.config.client_side_validation && stream_id.nil?
    fail ArgumentError, "Missing the required parameter 'stream_id' when calling StreamApi.v1_stream_get"
  end
  # resource path
  local_var_path = '/api/v1/stream/{stream_id}'.sub('{' + 'stream_id' + '}', CGI.escape(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']) 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] || 'StreamOut'

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

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

#v1_stream_list(opts = {}) ⇒ ListResponseStreamOut

List Streams List of all the organization’s streams.

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:



383
384
385
386
 
# File 'lib/svix/api/stream_api.rb', line 383

def v1_stream_list(opts = {})
  data, _status_code, _headers = v1_stream_list_with_http_info(opts)
  data
end

#v1_stream_list_with_http_info(opts = {}) ⇒ Array<(ListResponseStreamOut, Integer, Hash)>

List Streams List of all the organization&#39;s streams.

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:

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

    ListResponseStreamOut data, response status code and response headers



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
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
 
# File 'lib/svix/api/stream_api.rb', line 395

def v1_stream_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StreamApi.v1_stream_list ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling StreamApi.v1_stream_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 StreamApi.v1_stream_list, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/v1/stream'

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

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

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

#v1_stream_patch(stream_id, stream_patch, opts = {}) ⇒ StreamOut

Patch Stream Partially update a stream.

Parameters:

  • stream_id (String)
  • stream_patch (StreamPatch)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



456
457
458
459
 
# File 'lib/svix/api/stream_api.rb', line 456

def v1_stream_patch(stream_id, stream_patch, opts = {})
  data, _status_code, _headers = v1_stream_patch_with_http_info(stream_id, stream_patch, opts)
  data
end

#v1_stream_patch_with_http_info(stream_id, stream_patch, opts = {}) ⇒ Array<(StreamOut, Integer, Hash)>

Patch Stream Partially update a stream.

Parameters:

  • stream_id (String)
  • stream_patch (StreamPatch)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    StreamOut data, response status code and response headers



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/svix/api/stream_api.rb', line 467

def v1_stream_patch_with_http_info(stream_id, stream_patch, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StreamApi.v1_stream_patch ...'
  end
  # verify the required parameter 'stream_id' is set
  if @api_client.config.client_side_validation && stream_id.nil?
    fail ArgumentError, "Missing the required parameter 'stream_id' when calling StreamApi.v1_stream_patch"
  end
  # verify the required parameter 'stream_patch' is set
  if @api_client.config.client_side_validation && stream_patch.nil?
    fail ArgumentError, "Missing the required parameter 'stream_patch' when calling StreamApi.v1_stream_patch"
  end
  # resource path
  local_var_path = '/api/v1/stream/{stream_id}'.sub('{' + 'stream_id' + '}', CGI.escape(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']) 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_patch)

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

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

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

#v1_stream_update(stream_id, stream_in, opts = {}) ⇒ StreamOut

Update Stream Update a stream.

Parameters:

  • stream_id (String)
  • stream_in (StreamIn)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



530
531
532
533
 
# File 'lib/svix/api/stream_api.rb', line 530

def v1_stream_update(stream_id, stream_in, opts = {})
  data, _status_code, _headers = v1_stream_update_with_http_info(stream_id, stream_in, opts)
  data
end

#v1_stream_update_with_http_info(stream_id, stream_in, opts = {}) ⇒ Array<(StreamOut, Integer, Hash)>

Update Stream Update a stream.

Parameters:

  • stream_id (String)
  • stream_in (StreamIn)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    StreamOut data, response status code and response headers



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/svix/api/stream_api.rb', line 541

def v1_stream_update_with_http_info(stream_id, stream_in, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StreamApi.v1_stream_update ...'
  end
  # verify the required parameter 'stream_id' is set
  if @api_client.config.client_side_validation && stream_id.nil?
    fail ArgumentError, "Missing the required parameter 'stream_id' when calling StreamApi.v1_stream_update"
  end
  # verify the required parameter 'stream_in' is set
  if @api_client.config.client_side_validation && stream_in.nil?
    fail ArgumentError, "Missing the required parameter 'stream_in' when calling StreamApi.v1_stream_update"
  end
  # resource path
  local_var_path = '/api/v1/stream/{stream_id}'.sub('{' + 'stream_id' + '}', CGI.escape(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']) 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_in)

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

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

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