Namirasoft Notification Sender API V1
Namira Software Corporation Notification Sender API Version 1 (1.4.15)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-notification-sender-api-v1
Commands
Healthz
Get
Returns the application health status
ns-notification-sender healthz get
Value
List
Returns the value list of a given table and column
ns-notification-sender value list {table} {column} {search} {field_id} {limit}
TopicCategory
List
Returns the topic category list
ns-notification-sender topiccategory list {filters} {page} {size} {sorts} {user_id}
Get
Returns a topic category by id.
ns-notification-sender topiccategory get {id}
Create
Creates a new topic category for an entity
ns-notification-sender topiccategory create {entity_id}
--category_id (String)
Delete
Deletes a topic category by an id.
ns-notification-sender topiccategory delete {entity_id} {id}
TopicField
List
Returns the topic field list
ns-notification-sender topicfield list {filters} {page} {size} {sorts} {user_id}
Get
Returns a topic field by id.
ns-notification-sender topicfield get {id}
Create
Creates a new topic field for an entity
ns-notification-sender topicfield create {entity_id}
--field_id (String)
--value (String)
Update
Updates a topic field by an id for an entity
ns-notification-sender topicfield update {entity_id} {id}
--field_id (String)
--value (String)
Delete
Deletes a topic field by an id.
ns-notification-sender topicfield delete {entity_id} {id}
TopicTag
List
Returns the topic tag list
ns-notification-sender topictag list {filters} {page} {size} {sorts} {user_id}
Get
Returns a topic tag by id.
ns-notification-sender topictag get {id}
Create
Creates a new topic tag for an entity
ns-notification-sender topictag create {entity_id}
--name (String)
--value (String)
Update
Updates a topic tag by an id for an entity
ns-notification-sender topictag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a topic tag by an id.
ns-notification-sender topictag delete {entity_id} {id}
Topic
Send
Sends an topic
ns-notification-sender topic send
--topic_id (String)
--title (String)
--message (String)
List
Returns the topic list
ns-notification-sender topic list {filters} {page} {size} {sorts} {user_id}
Get
Returns a topic by an id
ns-notification-sender topic get {id}
Create
Creates a new topic
ns-notification-sender topic create
--workspace_id (String)
--name (String)
--description (String)
--topic_category (Array)
--topic_field (Array)
--topic_tag (Array)
Update
Updates a topic by an id
ns-notification-sender topic update {id}
--workspace_id (String)
--name (String)
--description (String)
--topic_category (Array)
--topic_field (Array)
--topic_tag (Array)
Delete
Deletes a topic by an id
ns-notification-sender topic delete {id}
SubscriberCategory
List
Returns the subscriber category list
ns-notification-sender subscribercategory list {filters} {page} {size} {sorts} {user_id}
Get
Returns a subscriber category by id.
ns-notification-sender subscribercategory get {id}
Create
Creates a new subscriber category for an entity
ns-notification-sender subscribercategory create {entity_id}
--category_id (String)
Delete
Deletes a subscriber category by an id.
ns-notification-sender subscribercategory delete {entity_id} {id}
SubscriberField
List
Returns the subscriber field list
ns-notification-sender subscriberfield list {filters} {page} {size} {sorts} {user_id}
Get
Returns a subscriber field by id.
ns-notification-sender subscriberfield get {id}
Create
Creates a new subscriber field for an entity
ns-notification-sender subscriberfield create {entity_id}
--field_id (String)
--value (String)
Update
Updates a subscriber field by an id for an entity
ns-notification-sender subscriberfield update {entity_id} {id}
--field_id (String)
--value (String)
Delete
Deletes a subscriber field by an id.
ns-notification-sender subscriberfield delete {entity_id} {id}
SubscriberTag
List
Returns the subscriber tag list
ns-notification-sender subscribertag list {filters} {page} {size} {sorts} {user_id}
Get
Returns a subscriber tag by id.
ns-notification-sender subscribertag get {id}
Create
Creates a new subscriber tag for an entity
ns-notification-sender subscribertag create {entity_id}
--name (String)
--value (String)
Update
Updates a subscriber tag by an id for an entity
ns-notification-sender subscribertag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a subscriber tag by an id.
ns-notification-sender subscribertag delete {entity_id} {id}
Subscriber
List
Returns the subscriber list
ns-notification-sender subscriber list {filters} {page} {size} {sorts} {user_id}
Get
Returns a subscriber by an id
ns-notification-sender subscriber get {id}
Create
Creates a new subscriber
ns-notification-sender subscriber create
--workspace_id (String)
--topic_id (String)
--sender_id (String)
--sender_type (Enum)
--name (String)
--value (String)
--description (String)
--subscriber_category (Array)
--subscriber_field (Array)
--subscriber_tag (Array)
Update
Updates a subscriber by an id
ns-notification-sender subscriber update {id}
--workspace_id (String)
--topic_id (String)
--sender_id (String)
--sender_type (Enum)
--name (String)
--value (String)
--description (String)
--subscriber_category (Array)
--subscriber_field (Array)
--subscriber_tag (Array)
Delete
Deletes a subscriber by an id
ns-notification-sender subscriber delete {id}
SentSubscriber
List
Returns the sent subscriber list
ns-notification-sender sentsubscriber list {filters} {page} {size} {sorts} {user_id}
Get
Returns a sent subscriber by an id
ns-notification-sender sentsubscriber get {id}
SentTopic
List
Returns the sent topic list
ns-notification-sender senttopic list {filters} {page} {size} {sorts} {user_id}
Get
Returns a sent topic by an id
ns-notification-sender senttopic get {id}
Schemas
TopicCategory
{ "name": "TopicCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityCategoryInput
{ "name": "EntityCategoryInput", "type": "Object", "required": true, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } }}
TopicField
{ "name": "TopicField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityFieldInput
{ "name": "EntityFieldInput", "type": "Object", "required": true, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false } }}
TopicTag
{ "name": "TopicTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityTagInput
{ "name": "EntityTagInput", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } }}
Topic
{ "name": "Topic", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
TopicFull
{ "name": "TopicFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "topic_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "topic_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false } } } ] }, "topic_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
TopicInput
{ "name": "TopicInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "topic_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "topic_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false } } } ] }, "topic_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
SubscriberCategory
{ "name": "SubscriberCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
SubscriberField
{ "name": "SubscriberField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
SubscriberTag
{ "name": "SubscriberTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Subscriber
{ "name": "Subscriber", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "topic_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "sender_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "sender_type": { "name": "SubscriberSenderType", "type": "Enum", "required": true, "valids": [ "Email", "SMS" ] }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "status": { "name": "SubscriberStatus", "type": "Enum", "required": true, "valids": [ "Pending", "Accepted", "Rejected" ] }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
SubscriberFull
{ "name": "SubscriberFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "topic_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "sender_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "sender_type": { "name": "SubscriberSenderType", "type": "Enum", "required": true, "valids": [ "Email", "SMS" ] }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "status": { "name": "SubscriberStatus", "type": "Enum", "required": true, "valids": [ "Pending", "Accepted", "Rejected" ] }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "subscriber_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "subscriber_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false } } } ] }, "subscriber_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
SubscriberInput
{ "name": "SubscriberInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "topic_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "sender_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "sender_type": { "name": "SubscriberSenderType", "type": "Enum", "required": true, "valids": [ "Email", "SMS" ] }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "subscriber_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "subscriber_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false } } } ] }, "subscriber_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
SentSubscriber
{ "name": "SentSubscriber", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true }, "user_id": { "type": "String", "required": true }, "device_id": { "type": "String", "required": true }, "session_id": { "type": "String", "required": true }, "topic_id": { "type": "String", "required": true }, "subscriber_id": { "type": "String", "required": true }, "subscriber_type": { "type": "String", "required": true }, "subscriber_value": { "type": "String", "required": true }, "message_id": { "type": "String", "required": true }, "title": { "type": "String", "required": true }, "message": { "type": "String", "required": true }, "created_at": { "type": "DateTime", "required": true }, "sent_at": { "type": "DateTime", "required": true }, "successful": { "type": "Boolean", "required": true }, "result": { "type": "String", "required": true } }}
SentTopic
{ "name": "SentTopic", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true }, "user_id": { "type": "String", "required": true }, "device_id": { "type": "String", "required": true }, "session_id": { "type": "String", "required": true }, "topic_id": { "type": "String", "required": true }, "title": { "type": "String", "required": true }, "message": { "type": "String", "required": true }, "created_at": { "type": "DateTime", "required": true }, "subscibers": { "type": "Double", "required": true }, "ignored": { "type": "Double", "required": true }, "error": { "type": "Double", "required": true }, "successful": { "type": "Double", "required": true }, "finished_at": { "type": "DateTime", "required": true } }}
Enums
SubscriberSenderType
SMS
SubscriberStatus
Pending
Accepted
Rejected
Namira Software Corporation
©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.