Class: Pingram::MembersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pingram/api/members_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MembersApi

Returns a new instance of MembersApi.



19
20
21
 
# File 'lib/pingram/api/members_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/pingram/api/members_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#members_get_auto_join(env_id, opts = {}) ⇒ AutoJoinGetResponse

Get auto-join domains for the organization

Parameters:

  • env_id (String) —

    Environment ID

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/pingram/api/members_api.rb', line 26

def members_get_auto_join(env_id, opts = {})
  data, _status_code, _headers = members_get_auto_join_with_http_info(env_id, opts)
  data
end

#members_get_auto_join_with_http_info(env_id, opts = {}) ⇒ Array<(AutoJoinGetResponse, Integer, Hash)>

Get auto-join domains for the organization

Parameters:

  • env_id (String) —

    Environment ID

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

    the optional parameters

Returns:

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

    AutoJoinGetResponse data, response status code and response headers



35
36
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
 
# File 'lib/pingram/api/members_api.rb', line 35

def members_get_auto_join_with_http_info(env_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.members_get_auto_join ...'
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling MembersApi.members_get_auto_join"
  end
  # resource path
  local_var_path = '/members/autojoin'.sub('{' + 'envId' + '}', CGI.escape(env_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] || 'AutoJoinGetResponse'

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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

#members_invite_member(env_id, member_invite_request, opts = {}) ⇒ InvitePostResponse

Invite a new member to the organization

Parameters:

  • env_id (String) —

    Environment ID

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

    the optional parameters

Returns:



88
89
90
91
 
# File 'lib/pingram/api/members_api.rb', line 88

def members_invite_member(env_id, member_invite_request, opts = {})
  data, _status_code, _headers = members_invite_member_with_http_info(env_id, member_invite_request, opts)
  data
end

#members_invite_member_with_http_info(env_id, member_invite_request, opts = {}) ⇒ Array<(InvitePostResponse, Integer, Hash)>

Invite a new member to the organization

Parameters:

  • env_id (String) —

    Environment ID

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

    the optional parameters

Returns:

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

    InvitePostResponse data, response status code and response headers



98
99
100
101
102
103
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
 
# File 'lib/pingram/api/members_api.rb', line 98

def members_invite_member_with_http_info(env_id, member_invite_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.members_invite_member ...'
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling MembersApi.members_invite_member"
  end
  # verify the required parameter 'member_invite_request' is set
  if @api_client.config.client_side_validation && member_invite_request.nil?
    fail ArgumentError, "Missing the required parameter 'member_invite_request' when calling MembersApi.members_invite_member"
  end
  # resource path
  local_var_path = '/members'.sub('{' + 'envId' + '}', CGI.escape(env_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(member_invite_request)

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

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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

#members_list_members(env_id, opts = {}) ⇒ Array<GetMembersResponseInner>

Get a list of team members in the organization

Parameters:

  • env_id (String) —

    Environment ID

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

    the optional parameters

Returns:



159
160
161
162
 
# File 'lib/pingram/api/members_api.rb', line 159

def members_list_members(env_id, opts = {})
  data, _status_code, _headers = members_list_members_with_http_info(env_id, opts)
  data
end

#members_list_members_with_http_info(env_id, opts = {}) ⇒ Array<(Array<GetMembersResponseInner>, Integer, Hash)>

Get a list of team members in the organization

Parameters:

  • env_id (String) —

    Environment ID

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

    the optional parameters

Returns:

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

    Array<GetMembersResponseInner> data, response status code and response headers



168
169
170
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
 
# File 'lib/pingram/api/members_api.rb', line 168

def members_list_members_with_http_info(env_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.members_list_members ...'
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling MembersApi.members_list_members"
  end
  # resource path
  local_var_path = '/members'.sub('{' + 'envId' + '}', CGI.escape(env_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] || 'Array<GetMembersResponseInner>'

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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

#members_remove_member(env_id, user_id, opts = {}) ⇒ SuccessResponse

Remove a member from the organization

Parameters:

  • env_id (String) —

    Environment ID

  • user_id (String) —

    User ID or email address (URL encoded)

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

    the optional parameters

Returns:



221
222
223
224
 
# File 'lib/pingram/api/members_api.rb', line 221

def members_remove_member(env_id, user_id, opts = {})
  data, _status_code, _headers = members_remove_member_with_http_info(env_id, user_id, opts)
  data
end

#members_remove_member_with_http_info(env_id, user_id, opts = {}) ⇒ Array<(SuccessResponse, Integer, Hash)>

Remove a member from the organization

Parameters:

  • env_id (String) —

    Environment ID

  • user_id (String) —

    User ID or email address (URL encoded)

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

    the optional parameters

Returns:

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

    SuccessResponse data, response status code and response headers



231
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
279
280
281
 
# File 'lib/pingram/api/members_api.rb', line 231

def members_remove_member_with_http_info(env_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.members_remove_member ...'
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling MembersApi.members_remove_member"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling MembersApi.members_remove_member"
  end
  # resource path
  local_var_path = '/members/{userId}'.sub('{' + 'envId' + '}', CGI.escape(env_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_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] || 'SuccessResponse'

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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

#members_set_auto_join(env_id, auto_join_request_body, opts = {}) ⇒ AutoJoinPostResponse

Set auto-join domains for the organization

Parameters:

  • env_id (String) —

    Environment ID

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

    the optional parameters

Returns:



288
289
290
291
 
# File 'lib/pingram/api/members_api.rb', line 288

def members_set_auto_join(env_id, auto_join_request_body, opts = {})
  data, _status_code, _headers = members_set_auto_join_with_http_info(env_id, auto_join_request_body, opts)
  data
end

#members_set_auto_join_with_http_info(env_id, auto_join_request_body, opts = {}) ⇒ Array<(AutoJoinPostResponse, Integer, Hash)>

Set auto-join domains for the organization

Parameters:

  • env_id (String) —

    Environment ID

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

    the optional parameters

Returns:

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

    AutoJoinPostResponse data, response status code and response headers



298
299
300
301
302
303
304
305
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
 
# File 'lib/pingram/api/members_api.rb', line 298

def members_set_auto_join_with_http_info(env_id, auto_join_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.members_set_auto_join ...'
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling MembersApi.members_set_auto_join"
  end
  # verify the required parameter 'auto_join_request_body' is set
  if @api_client.config.client_side_validation && auto_join_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'auto_join_request_body' when calling MembersApi.members_set_auto_join"
  end
  # resource path
  local_var_path = '/members/autojoin'.sub('{' + 'envId' + '}', CGI.escape(env_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(auto_join_request_body)

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

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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

#members_update(env_id, user_id, member_update_request, opts = {}) ⇒ SuccessResponse

Updates a specified member. The role update operation is restricted to administrators only.

Parameters:

  • env_id (String) —

    Environment ID

  • user_id (String) —

    User ID to update

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

    the optional parameters

Returns:



361
362
363
364
 
# File 'lib/pingram/api/members_api.rb', line 361

def members_update(env_id, user_id, member_update_request, opts = {})
  data, _status_code, _headers = members_update_with_http_info(env_id, user_id, member_update_request, opts)
  data
end

#members_update_with_http_info(env_id, user_id, member_update_request, opts = {}) ⇒ Array<(SuccessResponse, Integer, Hash)>

Updates a specified member. The role update operation is restricted to administrators only.

Parameters:

  • env_id (String) —

    Environment ID

  • user_id (String) —

    User ID to update

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

    the optional parameters

Returns:

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

    SuccessResponse data, response status code and response headers



372
373
374
375
376
377
378
379
380
381
382
383
384
385
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
 
# File 'lib/pingram/api/members_api.rb', line 372

def members_update_with_http_info(env_id, user_id, member_update_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.members_update ...'
  end
  # verify the required parameter 'env_id' is set
  if @api_client.config.client_side_validation && env_id.nil?
    fail ArgumentError, "Missing the required parameter 'env_id' when calling MembersApi.members_update"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling MembersApi.members_update"
  end
  # verify the required parameter 'member_update_request' is set
  if @api_client.config.client_side_validation && member_update_request.nil?
    fail ArgumentError, "Missing the required parameter 'member_update_request' when calling MembersApi.members_update"
  end
  # resource path
  local_var_path = '/members/{userId}'.sub('{' + 'envId' + '}', CGI.escape(env_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_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(member_update_request)

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

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

  new_options = opts.merge(
    :operation => :"MembersApi.members_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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MembersApi#members_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end