Class: TogaiClient::EventSchemasApi

Inherits:
Object
  • Object
show all
Defined in:
lib/togai_client/api/event_schemas_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EventSchemasApi

Returns a new instance of EventSchemasApi.



19
20
21
 
# File 'lib/togai_client/api/event_schemas_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/togai_client/api/event_schemas_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#activate_event_schema(event_schema_name, opts = {}) ⇒ EventSchema

Activate an event schema Activate an event schema

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 27

def activate_event_schema(event_schema_name, opts = {})
  data, _status_code, _headers = activate_event_schema_with_http_info(event_schema_name, opts)
  data
end

#activate_event_schema_with_http_info(event_schema_name, opts = {}) ⇒ Array<(EventSchema, Integer, Hash)>

Activate an event schema Activate an event schema

Parameters:

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

    the optional parameters

Returns:

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

    EventSchema data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 37

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

  # resource path
  local_var_path = '/event_schema/{event_schema_name}/activate'.sub('{' + 'event_schema_name' + '}', CGI.escape(event_schema_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] || 'EventSchema'

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

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

#create_event_schema(create_event_schema_request, opts = {}) ⇒ EventSchema

Create an event schema Create an event schema with attributes and dimensions to process events.

Parameters:

  • create_event_schema_request (CreateEventSchemaRequest) —

    Payload to create event schema

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 94

def create_event_schema(create_event_schema_request, opts = {})
  data, _status_code, _headers = create_event_schema_with_http_info(create_event_schema_request, opts)
  data
end

#create_event_schema_with_http_info(create_event_schema_request, opts = {}) ⇒ Array<(EventSchema, Integer, Hash)>

Create an event schema Create an event schema with attributes and dimensions to process events.

Parameters:

  • create_event_schema_request (CreateEventSchemaRequest) —

    Payload to create event schema

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

    the optional parameters

Returns:

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

    EventSchema data, response status code and response headers



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 104

def create_event_schema_with_http_info(create_event_schema_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventSchemasApi.create_event_schema ...'
  end
  # verify the required parameter 'create_event_schema_request' is set
  if @api_client.config.client_side_validation && create_event_schema_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_event_schema_request' when calling EventSchemasApi.create_event_schema"
  end
  # resource path
  local_var_path = '/event_schema'

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

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

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

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

#deactivate_event_schema(event_schema_name, opts = {}) ⇒ EventSchema

Deactivate an event schema You can deactivate an event schema using this API. In case you have an activate usage meter associated with the event schema, you will need to deactivate it first and then try deactivating the event schema.

Parameters:

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

    the optional parameters

Returns:



162
163
164
165
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 162

def deactivate_event_schema(event_schema_name, opts = {})
  data, _status_code, _headers = deactivate_event_schema_with_http_info(event_schema_name, opts)
  data
end

#deactivate_event_schema_with_http_info(event_schema_name, opts = {}) ⇒ Array<(EventSchema, Integer, Hash)>

Deactivate an event schema You can deactivate an event schema using this API. In case you have an activate usage meter associated with the event schema, you will need to deactivate it first and then try deactivating the event schema.

Parameters:

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

    the optional parameters

Returns:

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

    EventSchema data, response status code and response headers



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 172

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

  # resource path
  local_var_path = '/event_schema/{event_schema_name}/deactivate'.sub('{' + 'event_schema_name' + '}', CGI.escape(event_schema_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] || 'EventSchema'

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

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

#delete_event_schema(event_schema_name, opts = {}) ⇒ BaseSuccessResponse

Delete an event schema To delete(archive) an event schema, you’re required to archive associated active usage meters if any.

Parameters:

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

    the optional parameters

Returns:



229
230
231
232
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 229

def delete_event_schema(event_schema_name, opts = {})
  data, _status_code, _headers = delete_event_schema_with_http_info(event_schema_name, opts)
  data
end

#delete_event_schema_with_http_info(event_schema_name, opts = {}) ⇒ Array<(BaseSuccessResponse, Integer, Hash)>

Delete an event schema To delete(archive) an event schema, you’re required to archive associated active usage meters if any.

Parameters:

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

    the optional parameters

Returns:

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

    BaseSuccessResponse data, response status code and response headers



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 239

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

  # resource path
  local_var_path = '/event_schema/{event_schema_name}'.sub('{' + 'event_schema_name' + '}', CGI.escape(event_schema_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] || 'BaseSuccessResponse'

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

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

#event_schema_event_schema_name_patch(event_schema_name, update_event_schema_request, opts = {}) ⇒ EventSchema

Update an event schema Update an event schema and add new attributes and dimensions Once an event schema is activated, you cannot update or delete existing attributes and dimensions however you can add new attributes and dimensions and update event schema description. operationId: updateEventSchema

Parameters:

  • event_schema_name (String)
  • update_event_schema_request (UpdateEventSchemaRequest) —

    Payload to update event schema

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

    the optional parameters

Returns:



297
298
299
300
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 297

def event_schema_event_schema_name_patch(event_schema_name, update_event_schema_request, opts = {})
  data, _status_code, _headers = event_schema_event_schema_name_patch_with_http_info(event_schema_name, update_event_schema_request, opts)
  data
end

#event_schema_event_schema_name_patch_with_http_info(event_schema_name, update_event_schema_request, opts = {}) ⇒ Array<(EventSchema, Integer, Hash)>

Update an event schema Update an event schema and add new attributes and dimensions Once an event schema is activated, you cannot update or delete existing attributes and dimensions however you can add new attributes and dimensions and update event schema description. operationId: updateEventSchema

Parameters:

  • event_schema_name (String)
  • update_event_schema_request (UpdateEventSchemaRequest) —

    Payload to update event schema

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

    the optional parameters

Returns:

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

    EventSchema data, response status code and response headers



308
309
310
311
312
313
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
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 308

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

  # verify the required parameter 'update_event_schema_request' is set
  if @api_client.config.client_side_validation && update_event_schema_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_event_schema_request' when calling EventSchemasApi.event_schema_event_schema_name_patch"
  end
  # resource path
  local_var_path = '/event_schema/{event_schema_name}'.sub('{' + 'event_schema_name' + '}', CGI.escape(event_schema_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(update_event_schema_request)

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

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

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

#get_event_schema(event_schema_name, opts = {}) ⇒ EventSchema

Get an event schema Get an event schema

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :version (Integer) —

    Optional version to get a specific version. Gets latest version if it is not provided.

Returns:



375
376
377
378
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 375

def get_event_schema(event_schema_name, opts = {})
  data, _status_code, _headers = get_event_schema_with_http_info(event_schema_name, opts)
  data
end

#get_event_schema_with_http_info(event_schema_name, opts = {}) ⇒ Array<(EventSchema, Integer, Hash)>

Get an event schema Get an event schema

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :version (Integer) —

    Optional version to get a specific version. Gets latest version if it is not provided.

Returns:

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

    EventSchema 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
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 386

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

  # resource path
  local_var_path = '/event_schema/{event_schema_name}'.sub('{' + 'event_schema_name' + '}', CGI.escape(event_schema_name.to_s))

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

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

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

#list_event_schema_versions(event_schema_name, opts = {}) ⇒ EventSchemaVersionsResponse

List all event schema versions Get a list of all the versions of an event schema

Parameters:

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

    the optional parameters

Returns:



444
445
446
447
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 444

def list_event_schema_versions(event_schema_name, opts = {})
  data, _status_code, _headers = list_event_schema_versions_with_http_info(event_schema_name, opts)
  data
end

#list_event_schema_versions_with_http_info(event_schema_name, opts = {}) ⇒ Array<(EventSchemaVersionsResponse, Integer, Hash)>

List all event schema versions Get a list of all the versions of an event schema

Parameters:

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

    the optional parameters

Returns:

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

    EventSchemaVersionsResponse data, response status code and response headers



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
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 454

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

  # resource path
  local_var_path = '/event_schema/{event_schema_name}/versions'.sub('{' + 'event_schema_name' + '}', CGI.escape(event_schema_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] || 'EventSchemaVersionsResponse'

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

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

#list_event_schemas(opts = {}) ⇒ EventSchemaListPaginatedResponse

List event schemas Returns a list of event schema with pagination.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Filter by provided status

  • :next_token (String)
  • :page_size (Float)

Returns:



513
514
515
516
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 513

def list_event_schemas(opts = {})
  data, _status_code, _headers = list_event_schemas_with_http_info(opts)
  data
end

#list_event_schemas_with_http_info(opts = {}) ⇒ Array<(EventSchemaListPaginatedResponse, Integer, Hash)>

List event schemas Returns a list of event schema with pagination.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    Filter by provided status

  • :next_token (String)
  • :page_size (Float)

Returns:



525
526
527
528
529
530
531
532
533
534
535
536
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
 
# File 'lib/togai_client/api/event_schemas_api.rb', line 525

def list_event_schemas_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EventSchemasApi.list_event_schemas ...'
  end
  allowable_values = ["ACTIVE", "INACTIVE"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/event_schema'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'nextToken'] = opts[:'next_token'] if !opts[:'next_token'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].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] || 'EventSchemaListPaginatedResponse'

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

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