fusionauth_client 1.56.0 → 1.57.0

data/doc/table_of_contents.html

@@ -1338,16 +1338,6 @@
     —
     <span class="container">FusionAuth::FusionAuthClient</span>
 
-  <li class="method">
-    <a href="FusionAuth/FusionAuthClient.html#method-i-retrieve_webhook_attempt_log">#retrieve_webhook_attempt_log</a>
-    &mdash;
-    <span class="container">FusionAuth::FusionAuthClient</span>
-
-  <li class="method">
-    <a href="FusionAuth/FusionAuthClient.html#method-i-retrieve_webhook_event_log">#retrieve_webhook_event_log</a>
-    &mdash;
-    <span class="container">FusionAuth::FusionAuthClient</span>
-
   <li class="method">
     <a href="FusionAuth/FusionAuthClient.html#method-i-retrieve_webhooks">#retrieve_webhooks</a>
     &mdash;
@@ -1508,11 +1498,6 @@
     &mdash;
     <span class="container">FusionAuth::FusionAuthClient</span>
 
-  <li class="method">
-    <a href="FusionAuth/FusionAuthClient.html#method-i-search_webhook_event_logs">#search_webhook_event_logs</a>
-    &mdash;
-    <span class="container">FusionAuth::FusionAuthClient</span>
-
   <li class="method">
     <a href="FusionAuth/FusionAuthClient.html#method-i-search_webhooks">#search_webhooks</a>
     &mdash;

data/fusionauth-ruby-client.iml

@@ -6,11 +6,11 @@
       <sourceFolder url="file://$MODULE_DIR$/lib" isTestSource="false" />
       <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
     </content>
-    <orderEntry type="jdk" jdkName="rbenv: 2.7.5" jdkType="RUBY_SDK" />
+    <orderEntry type="jdk" jdkName="rbenv: 3.4.2" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.4.22, rbenv: 2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="cgi (v0.4.1, rbenv: 2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="psych (v5.1.2, rbenv: 2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rake (v13.2.1, rbenv: 2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.6.2, rbenv: 3.4.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="cgi (v0.4.2, rbenv: 3.4.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="psych (v5.2.3, rbenv: 3.4.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.2.1, rbenv: 3.4.2) [gem]" level="application" />
   </component>
-</module>
+</module>

data/fusionauth_client.gemspec

@@ -19,7 +19,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name = 'fusionauth_client'
-  spec.version = '1.56.0'
+  spec.version = '1.57.0'
   spec.authors = ['Brian Pontarelli', 'Daniel DeGroff']
   spec.email = %w(brian@fusionauth.io daniel@fusionauth.io)
 

data/lib/fusionauth/fusionauth_client.rb

@@ -1840,6 +1840,20 @@ module FusionAuth
           .go
     end
 
+    #
+    # Updates, via PATCH, the Entity with the given Id.
+    #
+    # @param entity_id [string] The Id of the Entity Type to update.
+    # @param request [OpenStruct, Hash] The request that contains just the new Entity information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_entity(entity_id, request)
+      start.uri('/api/entity')
+          .url_segment(entity_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .patch
+          .go
+    end
+
     #
     # Updates, via PATCH, the Entity Type with the given Id.
     #
@@ -1854,6 +1868,51 @@ module FusionAuth
           .go
     end
 
+    #
+    # Patches the permission with the given Id for the entity type.
+    #
+    # @param entity_type_id [string] The Id of the entityType that the permission belongs to.
+    # @param permission_id [string] The Id of the permission to patch.
+    # @param request [OpenStruct, Hash] The request that contains the new permission information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_entity_type_permission(entity_type_id, permission_id, request)
+      start.uri('/api/entity/type')
+          .url_segment(entity_type_id)
+          .url_segment("permission")
+          .url_segment(permission_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .patch
+          .go
+    end
+
+    #
+    # Patches the form with the given Id.
+    #
+    # @param form_id [string] The Id of the form to patch.
+    # @param request [OpenStruct, Hash] The request object that contains the new form information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_form(form_id, request)
+      start.uri('/api/form')
+          .url_segment(form_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .patch
+          .go
+    end
+
+    #
+    # Patches the form field with the given Id.
+    #
+    # @param field_id [string] The Id of the form field to patch.
+    # @param request [OpenStruct, Hash] The request object that contains the new form field information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_form_field(field_id, request)
+      start.uri('/api/form/field')
+          .url_segment(field_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .patch
+          .go
+    end
+
     #
     # Updates, via PATCH, the group with the given Id.
     #
@@ -1868,6 +1927,20 @@ module FusionAuth
           .go
     end
 
+    #
+    # Update the IP Access Control List with the given Id.
+    #
+    # @param access_control_list_id [string] The Id of the IP Access Control List to patch.
+    # @param request [OpenStruct, Hash] The request that contains the new IP Access Control List information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_ip_access_control_list(access_control_list_id, request)
+      start.uri('/api/ip-acl')
+          .url_segment(access_control_list_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .patch
+          .go
+    end
+
     #
     # Updates, via PATCH, the identity provider with the given Id.
     #
@@ -2063,6 +2136,20 @@ module FusionAuth
           .go
     end
 
+    #
+    # Patches the webhook with the given Id.
+    #
+    # @param webhook_id [string] The Id of the webhook to update.
+    # @param request [OpenStruct, Hash] The request that contains the new webhook information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_webhook(webhook_id, request)
+      start.uri('/api/webhook')
+          .url_segment(webhook_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .patch
+          .go
+    end
+
     #
     # Reactivates the application with the given Id.
     #
@@ -4304,6 +4391,20 @@ module FusionAuth
           .go
     end
 
+    #
+    # Updates a family with a given Id.
+    #
+    # @param family_id [string] The Id of the family to update.
+    # @param request [OpenStruct, Hash] The request object that contains all the new family information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_family(family_id, request)
+      start.uri('/api/user/family')
+          .url_segment(family_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put
+          .go
+    end
+
     #
     # Updates the form with the given Id.
     #

data/run-act.sh

@@ -0,0 +1,130 @@
+#!/usr/bin/env bash
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+EVENT="workflow_dispatch"
+INPUTS=""
+PARSED_INPUTS=()
+PROFILE=""
+VERBOSE=false
+WORKFLOW=""
+
+# Script metadata. Don't modify this.
+MYDIR=$(cd -- "$(dirname "$0")" >/dev/null 2>&1; pwd -P)
+cd "${MYDIR}"
+MYNAME=$(basename "$0")
+
+# Configure colorful messages.
+GRAY=$(tput setaf 248)
+GREEN=$(tput setaf 2)
+RED=$(tput setaf 202)
+RESET=$(tput sgr0)
+
+# Output formatting.
+function success() { echo -e "${GREEN}${1}${RESET}"; }
+function info()    { echo -e "${GRAY}${1}${RESET}"; }
+function error()   { echo -e "${RED}ERROR: ${1}${RESET}" >&2; }
+function fail()    { echo -e "\n${RED}ERROR: ${1}${RESET}" >&2; exit 1; }
+function argerr()  { echo -e "\n${RED}ERROR: ${1}${RESET}" >&2; show_help; }
+
+# Helper functions.
+function file_missing() { if [[ -f "${1}" ]]; then return 1; else return 0; fi }
+
+function show_help() {
+  echo -e "\nUsage: ${MYNAME} --workflow [workflow-name.yaml] --profile [aws-profile-name]\n"
+  echo -e "    Flags            Description                     Req    Default"
+  echo -e "    -------------    ----------------------------    ---    -------------------"
+  echo -e "    -e --event       Github event to simulate               workflow_dispatch"
+  echo -e "    -i --inputs      CSV list of k/v pairs            *     ${GRAY}null${RESET}"
+  echo -e "    -p --profile     AWS profile to use for auth      Y     ${GRAY}null${RESET}"
+  echo -e "    -v --verbose     Enable verbose mode (set -xv)          ${GRAY}disabled${RESET}"
+  echo -e "    -w --workflow    Path/file of workflow to run     Y     ${GRAY}null${RESET}"
+  echo -e "    -h --help        Show this message\n"
+  echo -e "    * --inputs requirements are determined by the workflow.\n"
+  echo -e "See https://nektosact.com/ for more info about 'act'.\n"
+  exit
+}
+
+
+function parse_args() {
+  # Parse the args.
+  while [[ $# -gt 0 ]]; do
+    case $1 in
+      -e|--event) shift
+        if (( $# < 1 )); then argerr "--event requires an event type [push|pull_request|workflow_dispatch]"
+        else EVENT="${1}"; fi
+        shift;;
+      -i|--inputs) shift
+        if (( $# < 1 )); then argerr "--inputs requires a csv list of input args"
+        else INPUTS="${1}"; fi
+        shift;;
+      -p|--profile) shift
+        if (( $# < 1 )); then argerr "--profile requires an AWS profile name"
+        else PROFILE="${1}"; fi
+        shift;;
+      -w|--workflow) shift
+        if (( $# < 1 )); then argerr "--workflow requires a path to a workflow file"
+        else WORKFLOW="${1}"; fi
+        shift;;
+      -v|--verbose) VERBOSE=true; shift;;
+      -h|--help) show_help;;
+      *) argerr "Unknown argument '$1'";;
+    esac
+  done
+
+  # Enable verbose mode if requested.
+  if [ "${VERBOSE}" = true ]; then set -xv; fi
+
+  # Make sure --workflow is passed.
+  if [[ -z "${WORKFLOW}" ]]; then argerr "--workflow is required"; fi
+  # Make sure --workflow is passed.
+  if [[ -z "${PROFILE}" ]]; then argerr "--profile is required"; fi
+  # Make sure workflow file exists
+  if file_missing "${WORKFLOW}"; then fail "Workflow '${WORKFLOW}' does not exist"; fi
+}
+
+
+function validate_prereqs() {
+  local prereqs="act gh"
+  for p in ${prereqs}; do
+    if ! command -v "${p}" &>/dev/null; then
+      error "${p} not found. Install it and try again."
+      if [[ "${p}" == "gh" ]]; then
+        info "\nAfter installing gh, login:"
+        info "    gh auth login"
+        info "\nMake sure you can get a token:"
+        info "    gh auth token"
+      fi
+      exit 1
+    fi
+  done
+}
+
+
+function parse_inputs() {
+  if [[ -n "${INPUTS}" ]]; then
+    IFS=","
+    for i in ${INPUTS}; do
+      PARSED_INPUTS+=(--input "${i}")
+    done
+  fi
+}
+
+
+function main() {
+  parse_args "$@"
+  validate_prereqs
+  parse_inputs
+
+  act "${EVENT}" \
+    --secret GITHUB_TOKEN="$(gh auth token)" \
+    --secret-file .env \
+    --workflows "${WORKFLOW}" \
+    --env-file <(aws configure export-credentials --profile "${PROFILE}" --format env) \
+    "${PARSED_INPUTS[@]}"
+}
+
+
+main "$@"

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusionauth_client
 version: !ruby/object:Gem::Version
-  version: 1.56.0
+  version: 1.57.0
 platform: ruby
 authors:
 - Brian Pontarelli
 - Daniel DeGroff
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-03-07 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.
@@ -90,12 +89,12 @@ files:
 - fusionauth_client.gemspec
 - lib/fusionauth/fusionauth_client.rb
 - lib/fusionauth/rest_client.rb
+- run-act.sh
 homepage: https://github.com/FusionAuth/fusionauth-ruby-client
 licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -110,8 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: The Ruby client library for FusionAuth
 test_files: []