Class: OpenapiClient::MembersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/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/openapi_client/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/openapi_client/api/members_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_organization_member(member_id, opts = {}) ⇒ nil

Delete Organization Member Deletes an account member matching the given id or email address. The member will be removed from the active account in permit.io. If the member is the only member in its account (organization), returns 400 (bad request), due to nobody remains with access to the account, meaning deletion of the entire account (org). To completely remove an account, call DELETE ‘/orgs/org`.

Parameters:

  • member_id (String) —

    Either the unique id (UUID) of the account member, or the email address of the account member.

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/openapi_client/api/members_api.rb', line 27

def delete_organization_member(member_id, opts = {})
  delete_organization_member_with_http_info(member_id, opts)
  nil
end

#delete_organization_member_with_http_info(member_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Organization Member Deletes an account member matching the given id or email address. The member will be removed from the active account in permit.io. If the member is the only member in its account (organization), returns 400 (bad request), due to nobody remains with access to the account, meaning deletion of the entire account (org). To completely remove an account, call DELETE &#x60;/orgs/org&#x60;.

Parameters:

  • member_id (String) —

    Either the unique id (UUID) of the account member, or the email address of the account member.

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/openapi_client/api/members_api.rb', line 37

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

  # 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 => :"MembersApi.delete_organization_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#delete_organization_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_authenticated_member(opts = {}) ⇒ OrgMemberRead

Get the authenticated account member Gets the authenticated account member’s details.

Parameters:

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

    the optional parameters

Returns:



89
90
91
92
 
# File 'lib/openapi_client/api/members_api.rb', line 89

def get_authenticated_member(opts = {})
  data, _status_code, _headers = get_authenticated_member_with_http_info(opts)
  data
end

#get_authenticated_member_with_http_info(opts = {}) ⇒ Array<(OrgMemberRead, Integer, Hash)>

Get the authenticated account member Gets the authenticated account member&#39;s details.

Parameters:

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

    the optional parameters

Returns:

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

    OrgMemberRead 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
 
# File 'lib/openapi_client/api/members_api.rb', line 98

def get_authenticated_member_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.get_authenticated_member ...'
  end
  # resource path
  local_var_path = '/v2/members/me'

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

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

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

#get_organization_member(member_id, opts = {}) ⇒ OrgMemberRead

Get Organization Member Gets a single account member by its id or email address. matching the given member, if no such member exists under the current active account (organization), returns 404.

Parameters:

  • member_id (String) —

    Either the unique id (UUID) of the account member, or the email address of the account member.

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

    the optional parameters

Returns:



147
148
149
150
 
# File 'lib/openapi_client/api/members_api.rb', line 147

def get_organization_member(member_id, opts = {})
  data, _status_code, _headers = get_organization_member_with_http_info(member_id, opts)
  data
end

#get_organization_member_with_http_info(member_id, opts = {}) ⇒ Array<(OrgMemberRead, Integer, Hash)>

Get Organization Member Gets a single account member by its id or email address. matching the given member, if no such member exists under the current active account (organization), returns 404.

Parameters:

  • member_id (String) —

    Either the unique id (UUID) of the account member, or the email address of the account member.

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

    the optional parameters

Returns:

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

    OrgMemberRead data, response status code and response headers



157
158
159
160
161
162
163
164
165
166
167
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
 
# File 'lib/openapi_client/api/members_api.rb', line 157

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

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

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

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

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

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

#list_organization_members(opts = {}) ⇒ Array<OrgMemberRead>

List Organization Members Lists all the account members that have access to the current active account. The active account/organization is determined by the API Key used or by the authenticated session id.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number of the results to fetch, starting at 1. (default to 1)

  • :per_page (Integer) —

    The number of results per page (max 100). (default to 30)

Returns:



211
212
213
214
 
# File 'lib/openapi_client/api/members_api.rb', line 211

def list_organization_members(opts = {})
  data, _status_code, _headers = list_organization_members_with_http_info(opts)
  data
end

#list_organization_members_with_http_info(opts = {}) ⇒ Array<(Array<OrgMemberRead>, Integer, Hash)>

List Organization Members Lists all the account members that have access to the current active account. The active account/organization is determined by the API Key used or by the authenticated session id.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number of the results to fetch, starting at 1. (default to 1)

  • :per_page (Integer) —

    The number of results per page (max 100). (default to 30)

Returns:

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

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



222
223
224
225
226
227
228
229
230
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
 
# File 'lib/openapi_client/api/members_api.rb', line 222

def list_organization_members_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.list_organization_members ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MembersApi.list_organization_members, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling MembersApi.list_organization_members, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling MembersApi.list_organization_members, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v2/members'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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] || 'Array<OrgMemberRead>'

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

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

#update_organization_member(member_id, org_member_update, opts = {}) ⇒ OrgMemberRead

Update Organization Member Updates an account member’s settings.

Parameters:

  • member_id (String) —

    Either the unique id (UUID) of the account member, or the email address of the account member.

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

    the optional parameters

Returns:



286
287
288
289
 
# File 'lib/openapi_client/api/members_api.rb', line 286

def update_organization_member(member_id, org_member_update, opts = {})
  data, _status_code, _headers = update_organization_member_with_http_info(member_id, org_member_update, opts)
  data
end

#update_organization_member_with_http_info(member_id, org_member_update, opts = {}) ⇒ Array<(OrgMemberRead, Integer, Hash)>

Update Organization Member Updates an account member&#39;s settings.

Parameters:

  • member_id (String) —

    Either the unique id (UUID) of the account member, or the email address of the account member.

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

    the optional parameters

Returns:

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

    OrgMemberRead data, response status code and response headers



297
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
 
# File 'lib/openapi_client/api/members_api.rb', line 297

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

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

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

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