Module: Novu::Api::Blueprints

Included in:
Client
Defined in:
lib/novu/api/blueprints.rb

Overview

Module Novu::Api::Blueprints provides an API for managing templated for notifications that are sent out in the Novu application.

This module includes methods for retrieving blueprints by templateID and grouping blueprints by category.

For more information on the Novu Blueprint API, see docs.novu.co/api/get-messages/.

Instance Method Summary collapse

Instance Method Details

#get_blueprint(template_id) ⇒ Hash, number

Returns the details of a particular template

Parameters:

  • `template_id` (String)

Returns:

  • (Hash) —

    The list of properties that pertains to the template e.g. _id, name, description, active, draft, preferenceSettings, and many others.

  • (number) —

    status

    • Returns 200 if successful



19
20
21
 
# File 'lib/novu/api/blueprints.rb', line 19

def get_blueprint(template_id)
  get("/blueprints/#{template_id}")
end

#group_blueprints_by_category ⇒ Object

Get V1blueprintsgroup by Category



24
25
26
 
# File 'lib/novu/api/blueprints.rb', line 24

def group_blueprints_by_category
  get("/blueprints/group-by-category")
end