fusionauth_client 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc8683bec78042fd17d0ed2562955670a75ab9bdd27ceceb5bffb89a6654ee64
-  data.tar.gz: 49e6fe7639264e156c6eaddeddfc64ab48dff2c7cab681e598b2f734816a729f
+  metadata.gz: 7e89b1ba98f8854aeee822471f967898b59d01fc16952e043a1fb1afeb4e3d53
+  data.tar.gz: f26f980b6da738bd591b696b8d895adb54f9c44af022efd30fc4a6fd4b4abe88
 SHA512:
-  metadata.gz: b2419465cf01b55dbaea773b8f60ac996ab9028911a785fbfb508caa858ca0d11805d37bcb614c69a6e12d291f8b40daabd26e57bf86ce746f8b014be2f46c63
-  data.tar.gz: c3ade115fec4b7e2aceb1038aa8e168ecd7780b616e8a44e9a05d3fbfb71f19603fec9e83f4d236e3620799c8ae4e06c1234755442317db74eeb21cf7e05c284
+  metadata.gz: 7d0e48bfa77c02437e3701dbb758954abe2a78a3bb42bf5856d0c3a13e891966e0518f38563a93142361e33c42692513c62e86418d3d4293c3c9b5c4644e5235
+  data.tar.gz: fc2429be921c05710d30e9cbdf7ee2f9f04fd7a239ea4d32ebb821643fb7588db4c318e77e3bd3b6cf8b59971dd73e35b70c55322f164edf3b6cc5d2bce17a34

data/build.savant

@@ -16,7 +16,7 @@
 savantVersion = "1.0.0"
 
 pubVersion = ""
-project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.6.0", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.7.0", licenses: ["ApacheV2_0"]) {
   workflow {
     standard()
   }

data/fusionauth_client.gemspec

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

data/lib/fusionauth/fusionauth_client.rb

@@ -54,6 +54,21 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Adds a user to an existing family. The family id must be specified.
+    #
+    # @param family_id [string] The id of the family.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to determine which user to add to the family.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def add_user_to_family(family_id, request)
+      start.uri('/api/user/family')
+           .url_segment(family_id)
+           .body_handler(FusionAuth::JSONBodyHandler.new(request))
+           .put()
+           .go()
+    end
+
     #
     # Cancels the user action.
     #
@@ -162,6 +177,21 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated.
+    #
+    # @param consent_id [string] (Optional) The Id for the consent. If not provided a secure random UUID will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the consent.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def create_consent(consent_id, request)
+      start.uri('/api/consent')
+           .url_segment(consent_id)
+           .body_handler(FusionAuth::JSONBodyHandler.new(request))
+           .post()
+           .go()
+    end
+
     #
     # Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
     #
@@ -177,6 +207,22 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Creates a family with the user id in the request as the owner and sole member of the family. You can optionally specify an id for the
+    # family, if not provided one will be generated.
+    #
+    # @param family_id [string] (Optional) The id for the family. If not provided a secure random UUID will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the family.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def create_family(family_id, request)
+      start.uri('/api/user/family')
+           .url_segment(family_id)
+           .body_handler(FusionAuth::JSONBodyHandler.new(request))
+           .post()
+           .go()
+    end
+
     #
     # Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.
     #
@@ -297,6 +343,21 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Creates a single User consent.
+    #
+    # @param user_consent_id [string] (Optional) The Id for the User consent. If not provided a secure random UUID will be generated.
+    # @param request [OpenStruct, Hash] The request that contains the user consent information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def create_user_consent(user_consent_id, request)
+      start.uri('/api/user/consent')
+           .url_segment(user_consent_id)
+           .body_handler(FusionAuth::JSONBodyHandler.new(request))
+           .post()
+           .go()
+    end
+
     #
     # Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
     #
@@ -398,6 +459,19 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Deletes the consent for the given Id.
+    #
+    # @param consent_id [string] The Id of the consent to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def delete_consent(consent_id)
+      start.uri('/api/consent')
+           .url_segment(consent_id)
+           .delete()
+           .go()
+    end
+
     #
     # Deletes the email template for the given Id.
     #
@@ -938,6 +1012,21 @@ module FusionAuth
            .go()
     end
 
+    #
+    # 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.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def remove_user_from_family(family_id, user_id)
+      start.uri('/api/user/family')
+           .url_segment(family_id)
+           .url_segment(user_id)
+           .delete()
+           .go()
+    end
+
     #
     # Re-sends the verification email to the user.
     #
@@ -1059,6 +1148,30 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Retrieves the Consent for the given Id.
+    #
+    # @param consent_id [string] The Id of the consent.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_consent(consent_id)
+      start.uri('/api/consent')
+           .url_segment(consent_id)
+           .get()
+           .go()
+    end
+
+    #
+    # Retrieves all of the consent.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_consents()
+      start.uri('/api/consent')
+           .get()
+           .go()
+    end
+
     #
     # 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.
@@ -1129,6 +1242,32 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Retrieves all of the families that a user belongs to.
+    #
+    # @param user_id [string] The User's id
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_families(user_id)
+      start.uri('/api/user/family')
+           .url_parameter('userId', user_id)
+           .get()
+           .go()
+    end
+
+    #
+    # Retrieves all of the members of a family by the unique Family Id.
+    #
+    # @param family_id [string] The unique Id of the Family.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_family_members_by_family_id(family_id)
+      start.uri('/api/user/family')
+           .url_segment(family_id)
+           .get()
+           .go()
+    end
+
     #
     # Retrieves the group for the given Id.
     #
@@ -1375,6 +1514,19 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Retrieves all of the children for the given parent email address.
+    #
+    # @param parent_email [string] The email of the parent.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_pending_children(parent_email)
+      start.uri('/api/user/family/pending')
+           .url_parameter('parentEmail', parent_email)
+           .get()
+           .go()
+    end
+
     #
     # Retrieves the last number of login records.
     #
@@ -1626,6 +1778,32 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Retrieve a single User consent by Id.
+    #
+    # @param user_consent_id [string] The User consent Id
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_user_consent(user_consent_id)
+      start.uri('/api/user/consent')
+           .url_segment(user_consent_id)
+           .get()
+           .go()
+    end
+
+    #
+    # Retrieves all of the consents for a User.
+    #
+    # @param user_id [string] The User's Id
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_user_consents(user_id)
+      start.uri('/api/user/consent')
+           .url_parameter('userId', user_id)
+           .get()
+           .go()
+    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
     # login counts for that application.
@@ -1738,6 +1916,19 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Revokes a single User consent by Id.
+    #
+    # @param user_consent_id [string] The User Consent Id
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def revoke_user_consent(user_consent_id)
+      start.uri('/api/user/consent')
+           .url_segment(user_consent_id)
+           .delete()
+           .go()
+    end
+
     #
     # Searches the audit logs with the specified criteria and pagination.
     #
@@ -1764,6 +1955,19 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Searches the login records with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def search_login_records(request)
+      start.uri('/api/system/login-record/search')
+           .body_handler(FusionAuth::JSONBodyHandler.new(request))
+           .post()
+           .go()
+    end
+
     #
     # Retrieves the users for the given ids. If any id is invalid, it is ignored.
     #
@@ -1807,6 +2011,19 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Sends out an email to a parent that they need to register and create a family or need to log in and add a child to their existing family.
+    #
+    # @param request [OpenStruct, Hash] The request object that contains the parent email.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def send_family_request_email(request)
+      start.uri('/api/user/family/request')
+           .body_handler(FusionAuth::JSONBodyHandler.new(request))
+           .post()
+           .go()
+    end
+
     #
     # Send a passwordless authentication code in an email to complete login.
     #
@@ -1892,6 +2109,21 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Updates the consent with the given Id.
+    #
+    # @param consent_id [string] The Id of the consent to update.
+    # @param request [OpenStruct, Hash] The request that contains all of the new consent information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def update_consent(consent_id, request)
+      start.uri('/api/consent')
+           .url_segment(consent_id)
+           .body_handler(FusionAuth::JSONBodyHandler.new(request))
+           .put()
+           .go()
+    end
+
     #
     # Updates the email template with the given Id.
     #
@@ -2068,6 +2300,21 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Updates a single User consent by Id.
+    #
+    # @param user_consent_id [string] The User Consent Id
+    # @param request [OpenStruct, Hash] The request that contains the user consent information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def update_user_consent(user_consent_id, request)
+      start.uri('/api/user/consent')
+           .url_segment(user_consent_id)
+           .body_handler(FusionAuth::JSONBodyHandler.new(request))
+           .put()
+           .go()
+    end
+
     #
     # Updates the webhook with the given Id.
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fusionauth_client
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Brian Pontarelli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-29 00:00:00.000000000 Z
+date: 2019-06-13 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.