Class: Svix::EventTypeApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EventTypeApi

Returns a new instance of EventTypeApi.



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

def api_client
  @api_client
end

Instance Method Details

#v1_event_type_create(event_type_in, opts = {}) ⇒ EventTypeOut

Create Event Type Create new or unarchive existing event type. Unarchiving an event type will allow endpoints to filter on it and messages to be sent with it. Endpoints filtering on the event type before archival will continue to filter on it. This operation does not preserve the description and schemas.

Parameters:

  • event_type_in (EventTypeIn)
  • 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/event_type_api.rb', line 28

def v1_event_type_create(event_type_in, opts = {})
  data, _status_code, _headers = v1_event_type_create_with_http_info(event_type_in, opts)
  data
end

#v1_event_type_create_with_http_info(event_type_in, opts = {}) ⇒ Array<(EventTypeOut, Integer, Hash)>

Create Event Type Create new or unarchive existing event type. Unarchiving an event type will allow endpoints to filter on it and messages to be sent with it. Endpoints filtering on the event type before archival will continue to filter on it. This operation does not preserve the description and schemas.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    The request&#39;s idempotency key

Returns:

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

    EventTypeOut 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/event_type_api.rb', line 39

def v1_event_type_create_with_http_info(event_type_in, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventTypeApi.v1_event_type_create ...'
  end
  # verify the required parameter 'event_type_in' is set
  if @api_client.config.client_side_validation && event_type_in.nil?
    fail ArgumentError, "Missing the required parameter 'event_type_in' when calling EventTypeApi.v1_event_type_create"
  end
  # resource path
  local_var_path = '/api/v1/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(event_type_in)

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

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

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

#v1_event_type_delete(event_type_name, opts = {}) ⇒ nil

Delete Event Type Archive an event type. Endpoints already configured to filter on an event type will continue to do so after archival. However, new messages can not be sent with it and endpoints can not filter on it. An event type can be unarchived with the [create operation](#operation/create_event_type_api_v1_event_type__post).

Parameters:

  • event_type_name (String) —

    The event type&#39;s name

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

    the optional parameters

Options Hash (opts):

  • :expunge (Boolean) —

    By default event types are archived when &quot;deleted&quot;. Passing this to &#x60;true&#x60; deletes them entirely. (default to false)

Returns:

  • (nil) 


99
100
101
102
 
# File 'lib/svix/api/event_type_api.rb', line 99

def v1_event_type_delete(event_type_name, opts = {})
  v1_event_type_delete_with_http_info(event_type_name, opts)
  nil
end

#v1_event_type_delete_with_http_info(event_type_name, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Event Type Archive an event type. Endpoints already configured to filter on an event type will continue to do so after archival. However, new messages can not be sent with it and endpoints can not filter on it. An event type can be unarchived with the [create operation](#operation/create_event_type_api_v1_event_type__post).

Parameters:

  • event_type_name (String) —

    The event type&#39;s name

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

    the optional parameters

Options Hash (opts):

  • :expunge (Boolean) —

    By default event types are archived when &quot;deleted&quot;. Passing this to &#x60;true&#x60; deletes them entirely. (default to false)

Returns:

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

    nil, response status code and response headers



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
164
165
166
 
# File 'lib/svix/api/event_type_api.rb', line 110

def v1_event_type_delete_with_http_info(event_type_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventTypeApi.v1_event_type_delete ...'
  end
  # verify the required parameter 'event_type_name' is set
  if @api_client.config.client_side_validation && event_type_name.nil?
    fail ArgumentError, "Missing the required parameter 'event_type_name' when calling EventTypeApi.v1_event_type_delete"
  end
  if @api_client.config.client_side_validation && event_type_name.to_s.length > 256
    fail ArgumentError, 'invalid value for "event_type_name" when calling EventTypeApi.v1_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 && event_type_name !~ pattern
    fail ArgumentError, "invalid value for 'event_type_name' when calling EventTypeApi.v1_event_type_delete, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/api/v1/event-type/{event_type_name}'.sub('{' + 'event_type_name' + '}', CGI.escape(event_type_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expunge'] = opts[:'expunge'] if !opts[:'expunge'].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]

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

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

#v1_event_type_export_openapi(opts = {}) ⇒ ExportEventTypeOut

Event Type Export From Openapi Exports event type definitions based on the OpenAPI schemas associated with each existing event type

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    The request&#39;s idempotency key

Returns:



173
174
175
176
 
# File 'lib/svix/api/event_type_api.rb', line 173

def v1_event_type_export_openapi(opts = {})
  data, _status_code, _headers = v1_event_type_export_openapi_with_http_info(opts)
  data
end

#v1_event_type_export_openapi_with_http_info(opts = {}) ⇒ Array<(ExportEventTypeOut, Integer, Hash)>

Event Type Export From Openapi Exports event type definitions based on the OpenAPI schemas associated with each existing event type

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    The request&#39;s idempotency key

Returns:

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

    ExportEventTypeOut data, response status code and response headers



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

def v1_event_type_export_openapi_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventTypeApi.v1_event_type_export_openapi ...'
  end
  # resource path
  local_var_path = '/api/v1/event-type/export/openapi'

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

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

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

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

#v1_event_type_generate_example(event_type_schema_in, opts = {}) ⇒ EventTypeExampleOut

Generate Schema Example Generates a fake example from the given JSONSchema

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    The request&#39;s idempotency key

Returns:



234
235
236
237
 
# File 'lib/svix/api/event_type_api.rb', line 234

def v1_event_type_generate_example(event_type_schema_in, opts = {})
  data, _status_code, _headers = v1_event_type_generate_example_with_http_info(event_type_schema_in, opts)
  data
end

#v1_event_type_generate_example_with_http_info(event_type_schema_in, opts = {}) ⇒ Array<(EventTypeExampleOut, Integer, Hash)>

Generate Schema Example Generates a fake example from the given JSONSchema

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    The request&#39;s idempotency key

Returns:

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

    EventTypeExampleOut data, response status code and response headers



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
297
 
# File 'lib/svix/api/event_type_api.rb', line 245

def v1_event_type_generate_example_with_http_info(event_type_schema_in, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventTypeApi.v1_event_type_generate_example ...'
  end
  # verify the required parameter 'event_type_schema_in' is set
  if @api_client.config.client_side_validation && event_type_schema_in.nil?
    fail ArgumentError, "Missing the required parameter 'event_type_schema_in' when calling EventTypeApi.v1_event_type_generate_example"
  end
  # resource path
  local_var_path = '/api/v1/event-type/schema/generate-example'

  # 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(event_type_schema_in)

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

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

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

#v1_event_type_get(event_type_name, opts = {}) ⇒ EventTypeOut

Get Event Type Get an event type.

Parameters:

  • event_type_name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:



304
305
306
307
 
# File 'lib/svix/api/event_type_api.rb', line 304

def v1_event_type_get(event_type_name, opts = {})
  data, _status_code, _headers = v1_event_type_get_with_http_info(event_type_name, opts)
  data
end

#v1_event_type_get_retry_schedule(event_type_name, opts = {}) ⇒ RetryScheduleInOut

Get Retry Schedule Gets the retry schedule for messages using the given event type

Parameters:

  • event_type_name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:



376
377
378
379
 
# File 'lib/svix/api/event_type_api.rb', line 376

def v1_event_type_get_retry_schedule(event_type_name, opts = {})
  data, _status_code, _headers = v1_event_type_get_retry_schedule_with_http_info(event_type_name, opts)
  data
end

#v1_event_type_get_retry_schedule_with_http_info(event_type_name, opts = {}) ⇒ Array<(RetryScheduleInOut, Integer, Hash)>

Get Retry Schedule Gets the retry schedule for messages using the given event type

Parameters:

  • event_type_name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:

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

    RetryScheduleInOut data, response status code and response headers



386
387
388
389
390
391
392
393
394
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
 
# File 'lib/svix/api/event_type_api.rb', line 386

def v1_event_type_get_retry_schedule_with_http_info(event_type_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventTypeApi.v1_event_type_get_retry_schedule ...'
  end
  # verify the required parameter 'event_type_name' is set
  if @api_client.config.client_side_validation && event_type_name.nil?
    fail ArgumentError, "Missing the required parameter 'event_type_name' when calling EventTypeApi.v1_event_type_get_retry_schedule"
  end
  if @api_client.config.client_side_validation && event_type_name.to_s.length > 256
    fail ArgumentError, 'invalid value for "event_type_name" when calling EventTypeApi.v1_event_type_get_retry_schedule, 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 && event_type_name !~ pattern
    fail ArgumentError, "invalid value for 'event_type_name' when calling EventTypeApi.v1_event_type_get_retry_schedule, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/api/v1/event-type/{event_type_name}/retry-schedule'.sub('{' + 'event_type_name' + '}', CGI.escape(event_type_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] || 'RetryScheduleInOut'

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

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

#v1_event_type_get_with_http_info(event_type_name, opts = {}) ⇒ Array<(EventTypeOut, Integer, Hash)>

Get Event Type Get an event type.

Parameters:

  • event_type_name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:

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

    EventTypeOut data, response status code and response headers



314
315
316
317
318
319
320
321
322
323
324
325
326
327
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
 
# File 'lib/svix/api/event_type_api.rb', line 314

def v1_event_type_get_with_http_info(event_type_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventTypeApi.v1_event_type_get ...'
  end
  # verify the required parameter 'event_type_name' is set
  if @api_client.config.client_side_validation && event_type_name.nil?
    fail ArgumentError, "Missing the required parameter 'event_type_name' when calling EventTypeApi.v1_event_type_get"
  end
  if @api_client.config.client_side_validation && event_type_name.to_s.length > 256
    fail ArgumentError, 'invalid value for "event_type_name" when calling EventTypeApi.v1_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 && event_type_name !~ pattern
    fail ArgumentError, "invalid value for 'event_type_name' when calling EventTypeApi.v1_event_type_get, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/api/v1/event-type/{event_type_name}'.sub('{' + 'event_type_name' + '}', CGI.escape(event_type_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] || 'EventTypeOut'

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

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

#v1_event_type_import_openapi(event_type_import_open_api_in, opts = {}) ⇒ EventTypeImportOpenApiOut

Event Type Import From Openapi Given an OpenAPI spec, create new or update existing event types. If an existing ‘archived` event type is updated, it will be unarchived. The importer will convert all webhooks found in the either the `webhooks` or `x-webhooks` top-level.

Parameters:

  • event_type_import_open_api_in (EventTypeImportOpenApiIn) —

    Import a list of event types from webhooks defined in an OpenAPI spec. The OpenAPI spec can be specified as either &#x60;spec&#x60; given the spec as a JSON object, or as &#x60;specRaw&#x60; (a &#x60;string&#x60;) which will be parsed as YAML or JSON by the server. Sending neither or both is invalid, resulting in a &#x60;400&#x60; **Bad Request**.

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    The request&#39;s idempotency key

Returns:



449
450
451
452
 
# File 'lib/svix/api/event_type_api.rb', line 449

def v1_event_type_import_openapi(event_type_import_open_api_in, opts = {})
  data, _status_code, _headers = v1_event_type_import_openapi_with_http_info(event_type_import_open_api_in, opts)
  data
end

#v1_event_type_import_openapi_with_http_info(event_type_import_open_api_in, opts = {}) ⇒ Array<(EventTypeImportOpenApiOut, Integer, Hash)>

Event Type Import From Openapi Given an OpenAPI spec, create new or update existing event types. If an existing &#x60;archived&#x60; event type is updated, it will be unarchived. The importer will convert all webhooks found in the either the &#x60;webhooks&#x60; or &#x60;x-webhooks&#x60; top-level.

Parameters:

  • event_type_import_open_api_in (EventTypeImportOpenApiIn) —

    Import a list of event types from webhooks defined in an OpenAPI spec. The OpenAPI spec can be specified as either &#x60;spec&#x60; given the spec as a JSON object, or as &#x60;specRaw&#x60; (a &#x60;string&#x60;) which will be parsed as YAML or JSON by the server. Sending neither or both is invalid, resulting in a &#x60;400&#x60; **Bad Request**.

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    The request&#39;s idempotency key

Returns:

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

    EventTypeImportOpenApiOut data, response status code and response headers



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

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

  # 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(event_type_import_open_api_in)

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

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

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

#v1_event_type_list(opts = {}) ⇒ ListResponseEventTypeOut

List Event Types Return the list of event types.

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

  • :include_archived (Boolean) —

    When &#x60;true&#x60; archived (deleted but not expunged) items are included in the response (default to false)

  • :with_content (Boolean) —

    When &#x60;true&#x60; the full item (including the schema) is included in the response (default to false)

Returns:



523
524
525
526
 
# File 'lib/svix/api/event_type_api.rb', line 523

def v1_event_type_list(opts = {})
  data, _status_code, _headers = v1_event_type_list_with_http_info(opts)
  data
end

#v1_event_type_list_with_http_info(opts = {}) ⇒ Array<(ListResponseEventTypeOut, Integer, Hash)>

List Event Types Return the list of event types.

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

  • :include_archived (Boolean) —

    When &#x60;true&#x60; archived (deleted but not expunged) items are included in the response (default to false)

  • :with_content (Boolean) —

    When &#x60;true&#x60; the full item (including the schema) is included in the response (default to false)

Returns:

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

    ListResponseEventTypeOut data, response status code and response headers



537
538
539
540
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
597
598
599
600
601
 
# File 'lib/svix/api/event_type_api.rb', line 537

def v1_event_type_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventTypeApi.v1_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 EventTypeApi.v1_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 EventTypeApi.v1_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 EventTypeApi.v1_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 EventTypeApi.v1_event_type_list, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/api/v1/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?
  query_params[:'include_archived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil?
  query_params[:'with_content'] = opts[:'with_content'] if !opts[:'with_content'].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] || 'ListResponseEventTypeOut'

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

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

#v1_event_type_patch(event_type_name, event_type_patch, opts = {}) ⇒ EventTypeOut

Patch Event Type Partially update an event type.

Parameters:

  • event_type_name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:



609
610
611
612
 
# File 'lib/svix/api/event_type_api.rb', line 609

def v1_event_type_patch(event_type_name, event_type_patch, opts = {})
  data, _status_code, _headers = v1_event_type_patch_with_http_info(event_type_name, event_type_patch, opts)
  data
end

#v1_event_type_patch_with_http_info(event_type_name, event_type_patch, opts = {}) ⇒ Array<(EventTypeOut, Integer, Hash)>

Patch Event Type Partially update an event type.

Parameters:

  • event_type_name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:

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

    EventTypeOut data, response status code and response headers



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/svix/api/event_type_api.rb', line 620

def v1_event_type_patch_with_http_info(event_type_name, event_type_patch, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventTypeApi.v1_event_type_patch ...'
  end
  # verify the required parameter 'event_type_name' is set
  if @api_client.config.client_side_validation && event_type_name.nil?
    fail ArgumentError, "Missing the required parameter 'event_type_name' when calling EventTypeApi.v1_event_type_patch"
  end
  if @api_client.config.client_side_validation && event_type_name.to_s.length > 256
    fail ArgumentError, 'invalid value for "event_type_name" when calling EventTypeApi.v1_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 && event_type_name !~ pattern
    fail ArgumentError, "invalid value for 'event_type_name' when calling EventTypeApi.v1_event_type_patch, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'event_type_patch' is set
  if @api_client.config.client_side_validation && event_type_patch.nil?
    fail ArgumentError, "Missing the required parameter 'event_type_patch' when calling EventTypeApi.v1_event_type_patch"
  end
  # resource path
  local_var_path = '/api/v1/event-type/{event_type_name}'.sub('{' + 'event_type_name' + '}', CGI.escape(event_type_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(event_type_patch)

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

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

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

#v1_event_type_update(event_type_name, event_type_update, opts = {}) ⇒ EventTypeOut

Update Event Type Update an event type.

Parameters:

  • event_type_name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:



692
693
694
695
 
# File 'lib/svix/api/event_type_api.rb', line 692

def v1_event_type_update(event_type_name, event_type_update, opts = {})
  data, _status_code, _headers = v1_event_type_update_with_http_info(event_type_name, event_type_update, opts)
  data
end

#v1_event_type_update_retry_schedule(event_type_name, retry_schedule_in_out, opts = {}) ⇒ RetryScheduleInOut

Update Retry Schedule Sets a retry schedule for all messages using the given event type

Parameters:

  • event_type_name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:



775
776
777
778
 
# File 'lib/svix/api/event_type_api.rb', line 775

def v1_event_type_update_retry_schedule(event_type_name, retry_schedule_in_out, opts = {})
  data, _status_code, _headers = v1_event_type_update_retry_schedule_with_http_info(event_type_name, retry_schedule_in_out, opts)
  data
end

#v1_event_type_update_retry_schedule_with_http_info(event_type_name, retry_schedule_in_out, opts = {}) ⇒ Array<(RetryScheduleInOut, Integer, Hash)>

Update Retry Schedule Sets a retry schedule for all messages using the given event type

Parameters:

  • event_type_name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:

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

    RetryScheduleInOut data, response status code and response headers



786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/svix/api/event_type_api.rb', line 786

def v1_event_type_update_retry_schedule_with_http_info(event_type_name, retry_schedule_in_out, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventTypeApi.v1_event_type_update_retry_schedule ...'
  end
  # verify the required parameter 'event_type_name' is set
  if @api_client.config.client_side_validation && event_type_name.nil?
    fail ArgumentError, "Missing the required parameter 'event_type_name' when calling EventTypeApi.v1_event_type_update_retry_schedule"
  end
  if @api_client.config.client_side_validation && event_type_name.to_s.length > 256
    fail ArgumentError, 'invalid value for "event_type_name" when calling EventTypeApi.v1_event_type_update_retry_schedule, 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 && event_type_name !~ pattern
    fail ArgumentError, "invalid value for 'event_type_name' when calling EventTypeApi.v1_event_type_update_retry_schedule, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'retry_schedule_in_out' is set
  if @api_client.config.client_side_validation && retry_schedule_in_out.nil?
    fail ArgumentError, "Missing the required parameter 'retry_schedule_in_out' when calling EventTypeApi.v1_event_type_update_retry_schedule"
  end
  # resource path
  local_var_path = '/api/v1/event-type/{event_type_name}/retry-schedule'.sub('{' + 'event_type_name' + '}', CGI.escape(event_type_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(retry_schedule_in_out)

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

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

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

#v1_event_type_update_with_http_info(event_type_name, event_type_update, opts = {}) ⇒ Array<(EventTypeOut, Integer, Hash)>

Update Event Type Update an event type.

Parameters:

  • event_type_name (String) —

    The event type&#39;s name

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

    the optional parameters

Returns:

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

    EventTypeOut data, response status code and response headers



703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
 
# File 'lib/svix/api/event_type_api.rb', line 703

def v1_event_type_update_with_http_info(event_type_name, event_type_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventTypeApi.v1_event_type_update ...'
  end
  # verify the required parameter 'event_type_name' is set
  if @api_client.config.client_side_validation && event_type_name.nil?
    fail ArgumentError, "Missing the required parameter 'event_type_name' when calling EventTypeApi.v1_event_type_update"
  end
  if @api_client.config.client_side_validation && event_type_name.to_s.length > 256
    fail ArgumentError, 'invalid value for "event_type_name" when calling EventTypeApi.v1_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 && event_type_name !~ pattern
    fail ArgumentError, "invalid value for 'event_type_name' when calling EventTypeApi.v1_event_type_update, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'event_type_update' is set
  if @api_client.config.client_side_validation && event_type_update.nil?
    fail ArgumentError, "Missing the required parameter 'event_type_update' when calling EventTypeApi.v1_event_type_update"
  end
  # resource path
  local_var_path = '/api/v1/event-type/{event_type_name}'.sub('{' + 'event_type_name' + '}', CGI.escape(event_type_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(event_type_update)

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

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

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