Class: Emailguard::MembersApi

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

def api_client
  @api_client
end

Instance Method Details

#api_v1_team_members_get(opts = {}) ⇒ ListPublicTeamMembersResponse

List team members Returns every member of the team, including role, profile fields, and join timestamp. Use the user_id field when calling member update or remove routes.

Parameters:

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

    the optional parameters

Returns:



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

def api_v1_team_members_get(opts = {})
  data, _status_code, _headers = api_v1_team_members_get_with_http_info(opts)
  data
end

#api_v1_team_members_get_with_http_info(opts = {}) ⇒ Array<(ListPublicTeamMembersResponse, Integer, Hash)>

List team members Returns every member of the team, including role, profile fields, and join timestamp. Use the `user_id` field when calling member update or remove routes.

Parameters:

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

    the optional parameters

Returns:



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

def api_v1_team_members_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.api_v1_team_members_get ...'
  end
  # resource path
  local_var_path = '/api/v1/team/members'

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

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

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

#api_v1_team_members_user_id_delete(user_id, opts = {}) ⇒ MessageResponse

Remove a team member Removes a user from the team. Identify the member by user account UUID in the path. The team owner cannot be removed through this endpoint.

Parameters:

  • user_id (String) —

    User account UUID of the member to remove

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

    the optional parameters

Returns:



84
85
86
87
 
# File 'lib/emailguard_sdk/api/members_api.rb', line 84

def api_v1_team_members_user_id_delete(user_id, opts = {})
  data, _status_code, _headers = api_v1_team_members_user_id_delete_with_http_info(user_id, opts)
  data
end

#api_v1_team_members_user_id_delete_with_http_info(user_id, opts = {}) ⇒ Array<(MessageResponse, Integer, Hash)>

Remove a team member Removes a user from the team. Identify the member by user account UUID in the path. The team owner cannot be removed through this endpoint.

Parameters:

  • user_id (String) —

    User account UUID of the member to remove

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

    the optional parameters

Returns:

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

    MessageResponse data, response status code and response headers



94
95
96
97
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/emailguard_sdk/api/members_api.rb', line 94

def api_v1_team_members_user_id_delete_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.api_v1_team_members_user_id_delete ...'
  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.api_v1_team_members_user_id_delete"
  end
  # resource path
  local_var_path = '/api/v1/team/members/{userId}'.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] || 'MessageResponse'

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

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

#api_v1_team_members_user_id_patch(user_id, update_team_member_input, opts = {}) ⇒ MessageResponse

Update a team member role Changes a member's role or internal notes. Identify the member by user account UUID in the path (not the team membership record ID).

Parameters:

  • user_id (String) —

    User account UUID of the member to update

  • update_team_member_input (UpdateTeamMemberInput) —

    New role and/or notes for the member

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

    the optional parameters

Returns:



148
149
150
151
 
# File 'lib/emailguard_sdk/api/members_api.rb', line 148

def api_v1_team_members_user_id_patch(user_id, update_team_member_input, opts = {})
  data, _status_code, _headers = api_v1_team_members_user_id_patch_with_http_info(user_id, update_team_member_input, opts)
  data
end

#api_v1_team_members_user_id_patch_with_http_info(user_id, update_team_member_input, opts = {}) ⇒ Array<(MessageResponse, Integer, Hash)>

Update a team member role Changes a member's role or internal notes. Identify the member by user account UUID in the path (not the team membership record ID).

Parameters:

  • user_id (String) —

    User account UUID of the member to update

  • update_team_member_input (UpdateTeamMemberInput) —

    New role and/or notes for the member

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

    the optional parameters

Returns:

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

    MessageResponse data, response status code and response headers



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
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/emailguard_sdk/api/members_api.rb', line 159

def api_v1_team_members_user_id_patch_with_http_info(user_id, update_team_member_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MembersApi.api_v1_team_members_user_id_patch ...'
  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.api_v1_team_members_user_id_patch"
  end
  # verify the required parameter 'update_team_member_input' is set
  if @api_client.config.client_side_validation && update_team_member_input.nil?
    fail ArgumentError, "Missing the required parameter 'update_team_member_input' when calling MembersApi.api_v1_team_members_user_id_patch"
  end
  # resource path
  local_var_path = '/api/v1/team/members/{userId}'.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(update_team_member_input)

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

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

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