Skip to content

ENG-2805: generated code for client libraries #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
robotdan merged 1 commit into from
Jul 18, 2025
Merged

ENG-2805: generated code for client libraries #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 48 additions & 48 deletions lib/fusionauth/fusionauth_client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
require 'fusionauth/rest_client'

#
# Copyright (c) 2018-2023, FusionAuth, All Rights Reserved
# Copyright (c) 2018-2025, FusionAuth, All Rights Reserved
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -751,7 +751,7 @@ def deactivate_user_action(user_action_id)
end

#
# Deactivates the users with the given ids.
# Deactivates the users with the given Ids.
#
# @param user_ids [Array] The ids of the users to deactivate.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
Expand All @@ -766,7 +766,7 @@ def deactivate_users(user_ids)
end

#
# Deactivates the users with the given ids.
# Deactivates the users with the given Ids.
#
# @param user_ids [Array] The ids of the users to deactivate.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
Expand Down Expand Up @@ -1208,8 +1208,8 @@ def delete_user_with_request(user_id, request)
end

#
# Deletes the users with the given ids, or users matching the provided JSON query or queryString.
# The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.
# Deletes the users with the given Ids, or users matching the provided JSON query or queryString.
# The order of preference is Ids, query and then queryString, it is recommended to only provide one of the three for the request.
#
# This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body.
# Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.
Expand All @@ -1225,8 +1225,8 @@ def delete_users(request)
end

#
# Deletes the users with the given ids, or users matching the provided JSON query or queryString.
# The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.
# Deletes the users with the given Ids, or users matching the provided JSON query or queryString.
# The order of preference is Ids, query and then queryString, it is recommended to only provide one of the three for the request.
#
# This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body.
# Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.
Expand Down Expand Up @@ -1747,7 +1747,7 @@ def lookup_identity_provider(domain)
# Modifies a temporal user action by changing the expiration of the action and optionally adding a comment to the
# action.
#
# @param action_id [string] The Id of the action to modify. This is technically the user action log id.
# @param action_id [string] The Id of the action to modify. This is technically the user action log Id.
# @param request [OpenStruct, Hash] The request that contains all the information about the modification.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
def modify_action(action_id, request)
Expand All @@ -1771,16 +1771,16 @@ def passwordless_login(request)
end

#
# Updates an authentication API key by given id
# Updates an API key with the given Id.
#
# @param key_id [string] The Id of the authentication key. If not provided a secure random api key will be generated.
# @param request [OpenStruct, Hash] The request object that contains all the information needed to create the APIKey.
# @param key_id [string] The Id of the API key. If not provided a secure random api key will be generated.
# @param request [OpenStruct, Hash] The request object that contains all the information needed to create the API key.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
def patch_api_key(key_id, request)
start.uri('/api/api-key')
.url_segment(key_id)
.body_handler(FusionAuth::JSONBodyHandler.new(request))
.post
.patch
.go
end

Expand Down Expand Up @@ -2289,7 +2289,7 @@ def reindex(request)
end

#
# Removes a user from the family with the given id.
# Removes a user from the family with the given Id.
#
# @param family_id [string] The Id of the family to remove the user from.
# @param user_id [string] The Id of the user to remove from the family.
Expand Down Expand Up @@ -2344,7 +2344,7 @@ def resend_registration_verification(email, application_id)
end

#
# Retrieves an authentication API key for the given id
# Retrieves an authentication API key for the given Id.
#
# @param key_id [string] The Id of the API key to retrieve.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
Expand Down Expand Up @@ -2410,7 +2410,7 @@ def retrieve_active_actions(user_id)
#
# Retrieves the application for the given Id or all the applications if the Id is null.
#
# @param application_id [string] (Optional) The application id.
# @param application_id [string] (Optional) The application Id.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
def retrieve_application(application_id)
start.uri('/api/application')
Expand Down Expand Up @@ -2486,10 +2486,10 @@ def retrieve_consents
end

#
# Retrieves the daily active user report between the two instants. If you specify an application id, it will only
# Retrieves the daily active user report between the two instants. If you specify an application Id, it will only
# return the daily active counts for that application.
#
# @param application_id [string] (Optional) The application id.
# @param application_id [string] (Optional) The application Id.
# @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
# @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
Expand All @@ -2503,7 +2503,7 @@ def retrieve_daily_active_report(application_id, start, _end)
end

#
# Retrieves the email template for the given Id. If you don't specify the id, this will return all the email templates.
# Retrieves the email template for the given Id. If you don't specify the Id, this will return all the email templates.
#
# @param email_template_id [string] (Optional) The Id of the email template.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
Expand Down Expand Up @@ -2886,10 +2886,10 @@ def retrieve_lambdas_by_type(type)
end

#
# Retrieves the login report between the two instants. If you specify an application id, it will only return the
# Retrieves the login report between the two instants. If you specify an application Id, it will only return the
# login counts for that application.
#
# @param application_id [string] (Optional) The application id.
# @param application_id [string] (Optional) The application Id.
# @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
# @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
Expand All @@ -2903,7 +2903,7 @@ def retrieve_login_report(application_id, start, _end)
end

#
# Retrieves the message template for the given Id. If you don't specify the id, this will return all the message templates.
# Retrieves the message template for the given Id. If you don't specify the Id, this will return all the message templates.
#
# @param message_template_id [string] (Optional) The Id of the message template.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
Expand Down Expand Up @@ -2959,10 +2959,10 @@ def retrieve_messengers
end

#
# Retrieves the monthly active user report between the two instants. If you specify an application id, it will only
# Retrieves the monthly active user report between the two instants. If you specify an application Id, it will only
# return the monthly active counts for that application.
#
# @param application_id [string] (Optional) The application id.
# @param application_id [string] (Optional) The application Id.
# @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
# @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
Expand Down Expand Up @@ -3125,7 +3125,7 @@ def retrieve_refresh_tokens(user_id)
end

#
# Retrieves the user registration for the user with the given Id and the given application id.
# Retrieves the user registration for the user with the given Id and the given application Id.
#
# @param user_id [string] The Id of the user.
# @param application_id [string] The Id of the application.
Expand All @@ -3139,10 +3139,10 @@ def retrieve_registration(user_id, application_id)
end

#
# Retrieves the registration report between the two instants. If you specify an application id, it will only return
# Retrieves the registration report between the two instants. If you specify an application Id, it will only return
# the registration counts for that application.
#
# @param application_id [string] (Optional) The application id.
# @param application_id [string] (Optional) The application Id.
# @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
# @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
Expand Down Expand Up @@ -3305,7 +3305,7 @@ def retrieve_user(user_id)
end

#
# Retrieves the user action for the given Id. If you pass in null for the id, this will return all the user
# Retrieves the user action for the given Id. If you pass in null for the Id, this will return all the user
# actions.
#
# @param user_action_id [string] (Optional) The Id of the user action.
Expand All @@ -3318,7 +3318,7 @@ def retrieve_user_action(user_action_id)
end

#
# Retrieves the user action reason for the given Id. If you pass in null for the id, this will return all the user
# Retrieves the user action reason for the given Id. If you pass in null for the Id, this will return all the user
# action reasons.
#
# @param user_action_reason_id [string] (Optional) The Id of the user action reason.
Expand Down Expand Up @@ -3417,8 +3417,8 @@ def retrieve_user_by_verification_id(verification_id)
#
# This API is useful if you want to build your own login workflow to complete a device grant.
#
# @param client_id [string] The client id.
# @param client_secret [string] The client id.
# @param client_id [string] The client Id.
# @param client_secret [string] The client Id.
# @param user_code [string] The end-user verification code.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
def retrieve_user_code(client_id, client_secret, user_code)
Expand Down Expand Up @@ -3531,11 +3531,11 @@ def retrieve_user_links_by_user_id(identity_provider_id, user_id)
end

#
# Retrieves the login report between the two instants for a particular user by Id. If you specify an application id, it will only return the
# Retrieves the login report between the two instants for a particular user by Id. If you specify an application Id, it will only return the
# login counts for that application.
#
# @param application_id [string] (Optional) The application id.
# @param user_id [string] The userId id.
# @param application_id [string] (Optional) The application Id.
# @param user_id [string] The userId Id.
# @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
# @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
Expand All @@ -3550,11 +3550,11 @@ def retrieve_user_login_report(application_id, user_id, start, _end)
end

#
# Retrieves the login report between the two instants for a particular user by login Id. If you specify an application id, it will only return the
# Retrieves the login report between the two instants for a particular user by login Id. If you specify an application Id, it will only return the
# login counts for that application.
#
# @param application_id [string] (Optional) The application id.
# @param login_id [string] The userId id.
# @param application_id [string] (Optional) The application Id.
# @param login_id [string] The userId Id.
# @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
# @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
Expand Down Expand Up @@ -3631,7 +3631,7 @@ def retrieve_web_authn_credentials_for_user(user_id)
end

#
# Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks.
# Retrieves the webhook for the given Id. If you pass in null for the Id, this will return all the webhooks.
#
# @param webhook_id [string] (Optional) The Id of the webhook.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
Expand Down Expand Up @@ -3863,7 +3863,7 @@ def search_entities(request)
end

#
# Retrieves the entities for the given ids. If any Id is invalid, it is ignored.
# Retrieves the entities for the given Ids. If any Id is invalid, it is ignored.
#
# @param ids [Array] The entity ids to search for.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
Expand Down Expand Up @@ -4031,7 +4031,7 @@ def search_user_comments(request)
end

#
# Retrieves the users for the given ids. If any Id is invalid, it is ignored.
# Retrieves the users for the given Ids. If any Id is invalid, it is ignored.
#
# @param ids [Array] The user ids to search for.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
Expand All @@ -4044,9 +4044,9 @@ def search_users(ids)
end

#
# Retrieves the users for the given ids. If any Id is invalid, it is ignored.
# Retrieves the users for the given Ids. If any Id is invalid, it is ignored.
#
# @param ids [Array] The user ids to search for.
# @param ids [Array] The user Ids to search for.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
def search_users_by_ids(ids)
start.uri('/api/user/search')
Expand Down Expand Up @@ -4107,7 +4107,7 @@ def search_webhooks(request)
end

#
# Send an email using an email template id. You can optionally provide <code>requestData</code> to access key value
# Send an email using an email template Id. You can optionally provide <code>requestData</code> to access key value
# pairs in the email template.
#
# @param email_template_id [string] The Id for the template.
Expand Down Expand Up @@ -4277,14 +4277,14 @@ def two_factor_login(request)
end

#
# Updates an API key by given id
# Updates an API key with the given Id.
#
# @param api_key_id [string] The Id of the API key to update.
# @param request [OpenStruct, Hash] The request object that contains all the information used to create the API Key.
# @param key_id [string] The Id of the API key to update.
# @param request [OpenStruct, Hash] The request that contains all the new API key information.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
def update_api_key(api_key_id, request)
def update_api_key(key_id, request)
start.uri('/api/api-key')
.url_segment(api_key_id)
.url_segment(key_id)
.body_handler(FusionAuth::JSONBodyHandler.new(request))
.put
.go
Expand Down Expand Up @@ -4733,7 +4733,7 @@ def upsert_entity_grant(entity_id, request)
# If you build your own activation form you should validate the user provided code prior to beginning the Authorization grant.
#
# @param user_code [string] The end-user verification code.
# @param client_id [string] The client id.
# @param client_id [string] The client Id.
# @return [FusionAuth::ClientResponse] The ClientResponse object.
def validate_device(user_code, client_id)
startAnonymous.uri('/oauth2/device/validate')
Expand Down