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

Inherits:

Object

• Object
• Hanko::Api::Admin::Metadata

Defined in:

lib/hanko/api/admin/metadata.rb

Overview

Admin resource for managing a user's metadata.

Instance Method Summary

• #get ⇒ Resource

  Fetch the user's metadata.

• #initialize(connection, user_base_path) ⇒ Metadata constructor

  Initialize the metadata resource scoped to a user.

• #update(**params) ⇒ Resource

  Update the user's metadata via PATCH.

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")

# 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:

• (Resource) —

  the metadata resource

# 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

# 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