Class: EmbedWorkflow::UsersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/embed_workflow/api/users_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsersApi

Returns a new instance of UsersApi.



19
20
21
 
# File 'lib/embed_workflow/api/users_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/embed_workflow/api/users_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_user_token(**opts) ⇒ CreateUserToken200Response

Create user token

Parameters:

  • opts (Hash) —

    the optional parameters

  • **extra (Hash) —

    Additional properties to include in the request body

Options Hash (**opts):

  • :key (String) —

    User's key

  • :id (String) —

    System-generated unique identifier

Returns:



28
29
30
31
32
33
34
35
36
 
# File 'lib/embed_workflow/api/users_api.rb', line 28

def create_user_token(**opts)
  opts[:'create_user_token_request'] = {
    key: opts.delete(:key),
    id: opts.delete(:id),
    **opts.reject { |k, _| k.to_s.start_with?('debug_') }
  }
  data, _status_code, _headers = create_user_token_with_http_info(opts)
  data
end

#create_user_token_with_http_info(opts = {}) ⇒ Array<(CreateUserToken200Response, Integer, Hash)>

Create user token

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CreateUserToken200Response data, response status code and response headers



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
 
# File 'lib/embed_workflow/api/users_api.rb', line 42

def create_user_token_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.create_user_token ...'
  end
  # resource path
  local_var_path = '/api/v1/user_token'

  # 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'])
  # 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(opts[:'create_user_token_request'])

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

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

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

#delete_user(key:, **opts) ⇒ ListUsers200ResponseCollectionInner

Delete user

Parameters:

  • key (String) —

    Client-provided unique identifier

  • opts (Hash) —

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/embed_workflow/api/users_api.rb', line 95

def delete_user(key:, **opts)
  data, _status_code, _headers = delete_user_with_http_info(key, opts)
  data
end

#delete_user_with_http_info(key, opts = {}) ⇒ Array<(ListUsers200ResponseCollectionInner, Integer, Hash)>

Delete user

Parameters:

  • key (String) —

    Client-provided unique identifier

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

    the optional parameters

Returns:



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
 
# File 'lib/embed_workflow/api/users_api.rb', line 104

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

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

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

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

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

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

#list_users(**opts) ⇒ ListUsers200Response

List users

Parameters:

  • opts (Hash) —

    the optional parameters

Options Hash (**opts):

  • :starting_after (String) —

    Cursor for pagination - return results after this ID

  • :ending_before (String) —

    Cursor for pagination - return results before this ID

  • :limit (Integer) —

    Number of items to return (max 100)

  • :search (String) —

    Search users by key

Returns:



159
160
161
162
 
# File 'lib/embed_workflow/api/users_api.rb', line 159

def list_users(**opts)
  data, _status_code, _headers = list_users_with_http_info(opts)
  data
end

#list_users_with_http_info(opts = {}) ⇒ Array<(ListUsers200Response, Integer, Hash)>

List users

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :starting_after (String) —

    Cursor for pagination - return results after this ID

  • :ending_before (String) —

    Cursor for pagination - return results before this ID

  • :limit (Integer) —

    Number of items to return (max 100)

  • :search (String) —

    Search users by key

Returns:

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

    ListUsers200Response data, response status code and response headers



171
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
 
# File 'lib/embed_workflow/api/users_api.rb', line 171

def list_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.list_users ...'
  end
  # resource path
  local_var_path = '/api/v1/users'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
  query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?

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

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

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

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

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

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

#retrieve_user(key:, **opts) ⇒ ListUsers200ResponseCollectionInner

Retrieve user

Parameters:

  • key (String) —

    Client-provided unique identifier

  • opts (Hash) —

    the optional parameters

Returns:



223
224
225
226
 
# File 'lib/embed_workflow/api/users_api.rb', line 223

def retrieve_user(key:, **opts)
  data, _status_code, _headers = retrieve_user_with_http_info(key, opts)
  data
end

#retrieve_user_with_http_info(key, opts = {}) ⇒ Array<(ListUsers200ResponseCollectionInner, Integer, Hash)>

Retrieve user

Parameters:

  • key (String) —

    Client-provided unique identifier

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

    the optional parameters

Returns:



232
233
234
235
236
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
 
# File 'lib/embed_workflow/api/users_api.rb', line 232

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

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

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

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

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

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

#upsert_user(key:, **opts) ⇒ ListUsers200ResponseCollectionInner

Upsert user

Parameters:

  • key (String) —

    Client-provided unique identifier

  • opts (Hash) —

    the optional parameters

Options Hash (**opts):

  • :name (String) —

    Name of resource

  • :email (String) —

    Email address

  • :data (Hash<String, Object>) —

    Additional user data

  • :groups (Array<String>) —

    User permission groups. Only available to users with admin role.

  • :time_zone (String) —

    Time zone

Returns:



289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/embed_workflow/api/users_api.rb', line 289

def upsert_user(key:, **opts)
  opts[:'upsert_user_request'] = UpsertUserRequest.new(
    name: opts.delete(:name),
    email: opts.delete(:email),
    data: opts.delete(:data),
    groups: opts.delete(:groups),
    time_zone: opts.delete(:time_zone),
  )
  data, _status_code, _headers = upsert_user_with_http_info(key, opts)
  data
end

#upsert_user_with_http_info(key, opts = {}) ⇒ Array<(ListUsers200ResponseCollectionInner, Integer, Hash)>

Upsert user

Parameters:

  • key (String) —

    Client-provided unique identifier

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

    the optional parameters

Options Hash (opts):

Returns:



306
307
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
 
# File 'lib/embed_workflow/api/users_api.rb', line 306

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

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

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

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