Class: Hanko::Api::Admin::Metadata

Inherits:
Object
  • Object
show all
Defined in:
lib/hanko/api/admin/metadata.rb

Overview

Admin resource for managing a user’s metadata.

Instance Method Summary collapse

Constructor Details

#initialize(connection, user_base_path) ⇒ Metadata

Initialize the metadata resource scoped to a user.

Parameters:

  • connection (Hanko::Connection) —

    the HTTP connection to use

  • user_base_path (String) —

    the base path for the parent user (e.g. “/users/:id”)



13
14
15
16
 
# File 'lib/hanko/api/admin/metadata.rb', line 13

def initialize(connection, user_base_path)
  @connection = connection
  @base_path = "#{user_base_path}/metadata"
end

Instance Method Details

#get ⇒ Resource

Fetch the user’s metadata.

Returns:



21
22
23
24
 
# File 'lib/hanko/api/admin/metadata.rb', line 21

def get
  response = @connection.get(@base_path)
  Resource.new(JSON.parse(response.body))
end

#update(**params) ⇒ Resource

Update the user’s metadata via PATCH.

Parameters:

  • params (Hash) —

    the metadata attributes to update

Returns:

  • (Resource) —

    the updated metadata resource



30
31
32
33
 
# File 'lib/hanko/api/admin/metadata.rb', line 30

def update(**params)
  response = @connection.patch(@base_path, params)
  Resource.new(JSON.parse(response.body))
end