Class: Zyphr::AuthUserProfileApi

Inherits:
Object
  • Object
show all
Defined in:
lib/zyphr/api/auth_user_profile_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AuthUserProfileApi

Returns a new instance of AuthUserProfileApi.



19
20
21
 
# File 'lib/zyphr/api/auth_user_profile_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/zyphr/api/auth_user_profile_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_end_user(opts = {}) ⇒ EndUserDeleteResponse

Delete current end user account Delete the current end user account (GDPR right to erasure). This is a soft delete — the account is marked as deleted but data is retained for a period to allow for recovery or legal requirements.

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/zyphr/api/auth_user_profile_api.rb', line 26

def delete_end_user(opts = {})
  data, _status_code, _headers = delete_end_user_with_http_info(opts)
  data
end

#delete_end_user_by_application(user_id, opts = {}) ⇒ nil

Delete an end user (test environment only) App-credentialed soft-delete for an end user, scoped to the test environment only. Live-mode credentials receive 403 — this is the intentional safety guard against a misconfigured CI runner nuking production users. Mirrors the self-service ‘DELETE /auth/users/me` flow: revokes all sessions, soft-deletes the row (status=’deleted’), and emits a ‘user.deleted` webhook with `method=’application_admin’‘. The audit log row survives (no FK to end_users), so org-history queries still resolve. Intended for smoke / test-fixture cleanup. Production deletes should continue to use `DELETE /auth/users/me` from the end-user’s own session or the dashboard.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


84
85
86
87
 
# File 'lib/zyphr/api/auth_user_profile_api.rb', line 84

def delete_end_user_by_application(user_id, opts = {})
  delete_end_user_by_application_with_http_info(user_id, opts)
  nil
end

#delete_end_user_by_application_with_http_info(user_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an end user (test environment only) App-credentialed soft-delete for an end user, scoped to the test environment only. Live-mode credentials receive 403 — this is the intentional safety guard against a misconfigured CI runner nuking production users. Mirrors the self-service &#x60;DELETE /auth/users/me&#x60; flow: revokes all sessions, soft-deletes the row (status&#x3D;&#39;deleted&#39;), and emits a &#x60;user.deleted&#x60; webhook with &#x60;method&#x3D;&#39;application_admin&#39;&#x60;. The audit log row survives (no FK to end_users), so org-history queries still resolve. Intended for smoke / test-fixture cleanup. Production deletes should continue to use &#x60;DELETE /auth/users/me&#x60; from the end-user&#39;s own session or the dashboard.

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/zyphr/api/auth_user_profile_api.rb', line 94

def delete_end_user_by_application_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthUserProfileApi.delete_end_user_by_application ...'
  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 AuthUserProfileApi.delete_end_user_by_application"
  end
  # resource path
  local_var_path = '/auth/users/{user_id}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # 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] || ['ApplicationSecret', 'ApplicationPublicKey']

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

#delete_end_user_with_http_info(opts = {}) ⇒ Array<(EndUserDeleteResponse, Integer, Hash)>

Delete current end user account Delete the current end user account (GDPR right to erasure). This is a soft delete — the account is marked as deleted but data is retained for a period to allow for recovery or legal requirements.

Parameters:

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

    the optional parameters

Returns:

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

    EndUserDeleteResponse 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
 
# File 'lib/zyphr/api/auth_user_profile_api.rb', line 35

def delete_end_user_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthUserProfileApi.delete_end_user ...'
  end
  # resource path
  local_var_path = '/auth/users/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']) 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] || 'EndUserDeleteResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['EndUserToken', 'ApplicationPublicKey']

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

#get_end_user(opts = {}) ⇒ AuthUserResponse

Get current end user profile Retrieve the profile of the currently authenticated end user.

Parameters:

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

    the optional parameters

Returns:



144
145
146
147
 
# File 'lib/zyphr/api/auth_user_profile_api.rb', line 144

def get_end_user(opts = {})
  data, _status_code, _headers = get_end_user_with_http_info(opts)
  data
end

#get_end_user_with_http_info(opts = {}) ⇒ Array<(AuthUserResponse, Integer, Hash)>

Get current end user profile Retrieve the profile of the currently authenticated end user.

Parameters:

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

    the optional parameters

Returns:

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

    AuthUserResponse data, response status code and response headers



153
154
155
156
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
 
# File 'lib/zyphr/api/auth_user_profile_api.rb', line 153

def get_end_user_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthUserProfileApi.get_end_user ...'
  end
  # resource path
  local_var_path = '/auth/users/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']) 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] || 'AuthUserResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['EndUserToken', 'ApplicationPublicKey']

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

#update_end_user(update_end_user_request, opts = {}) ⇒ AuthUserResponse

Update current end user profile Update the profile of the currently authenticated end user.

Parameters:

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

    the optional parameters

Returns:



202
203
204
205
 
# File 'lib/zyphr/api/auth_user_profile_api.rb', line 202

def update_end_user(update_end_user_request, opts = {})
  data, _status_code, _headers = update_end_user_with_http_info(update_end_user_request, opts)
  data
end

#update_end_user_with_http_info(update_end_user_request, opts = {}) ⇒ Array<(AuthUserResponse, Integer, Hash)>

Update current end user profile Update the profile of the currently authenticated end user.

Parameters:

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

    the optional parameters

Returns:

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

    AuthUserResponse data, response status code and response headers



212
213
214
215
216
217
218
219
220
221
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
 
# File 'lib/zyphr/api/auth_user_profile_api.rb', line 212

def update_end_user_with_http_info(update_end_user_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AuthUserProfileApi.update_end_user ...'
  end
  # verify the required parameter 'update_end_user_request' is set
  if @api_client.config.client_side_validation && update_end_user_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_end_user_request' when calling AuthUserProfileApi.update_end_user"
  end
  # resource path
  local_var_path = '/auth/users/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']) 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_end_user_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['EndUserToken', 'ApplicationPublicKey']

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