Class: TogaiClient::FeatureApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FeatureApi

Returns a new instance of FeatureApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_feature(create_feature_request, opts = {}) ⇒ Feature

Create a Feature and optionally associate with one or more event_schemas Create a Feature optionally associate with one or more event_schemas

Parameters:

  • create_feature_request (CreateFeatureRequest) —

    Payload to create a Feature along the association with event_schemas

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

    the optional parameters

Returns:



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

def create_feature(create_feature_request, opts = {})
  data, _status_code, _headers = create_feature_with_http_info(create_feature_request, opts)
  data
end

#create_feature_with_http_info(create_feature_request, opts = {}) ⇒ Array<(Feature, Integer, Hash)>

Create a Feature and optionally associate with one or more event_schemas Create a Feature optionally associate with one or more event_schemas

Parameters:

  • create_feature_request (CreateFeatureRequest) —

    Payload to create a Feature along the association with event_schemas

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

    the optional parameters

Returns:

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

    Feature data, response status code and response headers



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

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

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

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

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

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

#get_feature(feature_id, opts = {}) ⇒ Feature

Get a Feature Get details of a Feature

Parameters:

  • feature_id (String) —

    feature_id corresponding to a feature

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/togai_client/api/feature_api.rb', line 95

def get_feature(feature_id, opts = {})
  data, _status_code, _headers = get_feature_with_http_info(feature_id, opts)
  data
end

#get_feature_with_http_info(feature_id, opts = {}) ⇒ Array<(Feature, Integer, Hash)>

Get a Feature Get details of a Feature

Parameters:

  • feature_id (String) —

    feature_id corresponding to a feature

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

    the optional parameters

Returns:

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

    Feature data, response status code and response headers



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/feature_api.rb', line 105

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

  # resource path
  local_var_path = '/features/{feature_id}'.sub('{' + 'feature_id' + '}', CGI.escape(feature_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] || 'Feature'

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

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

#get_features(opts = {}) ⇒ FeaturePaginatedListData

List Feature Get a list of features along with its associations

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



163
164
165
166
 
# File 'lib/togai_client/api/feature_api.rb', line 163

def get_features(opts = {})
  data, _status_code, _headers = get_features_with_http_info(opts)
  data
end

#get_features_with_http_info(opts = {}) ⇒ Array<(FeaturePaginatedListData, Integer, Hash)>

List Feature Get a list of features along with its associations

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    FeaturePaginatedListData data, response status code and response headers



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
 
# File 'lib/togai_client/api/feature_api.rb', line 174

def get_features_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeatureApi.get_features ...'
  end
  # resource path
  local_var_path = '/features'

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

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

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

#update_feature(feature_id, update_feature_request, opts = {}) ⇒ Feature

Update a Feature Update an existing feature and its eventSchema associations

Parameters:

  • feature_id (String) —

    feature_id corresponding to a feature

  • update_feature_request (UpdateFeatureRequest) —

    Payload to update a Feature along the associations with event_schemas

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

    the optional parameters

Returns:



226
227
228
229
 
# File 'lib/togai_client/api/feature_api.rb', line 226

def update_feature(feature_id, update_feature_request, opts = {})
  data, _status_code, _headers = update_feature_with_http_info(feature_id, update_feature_request, opts)
  data
end

#update_feature_with_http_info(feature_id, update_feature_request, opts = {}) ⇒ Array<(Feature, Integer, Hash)>

Update a Feature Update an existing feature and its eventSchema associations

Parameters:

  • feature_id (String) —

    feature_id corresponding to a feature

  • update_feature_request (UpdateFeatureRequest) —

    Payload to update a Feature along the associations with event_schemas

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

    the optional parameters

Returns:

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

    Feature data, response status code and response headers



237
238
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
290
291
292
293
294
295
296
 
# File 'lib/togai_client/api/feature_api.rb', line 237

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

  # verify the required parameter 'update_feature_request' is set
  if @api_client.config.client_side_validation && update_feature_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_feature_request' when calling FeatureApi.update_feature"
  end
  # resource path
  local_var_path = '/features/{feature_id}'.sub('{' + 'feature_id' + '}', CGI.escape(feature_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(update_feature_request)

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

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

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