Namirasoft Message API V1
Namira Software Corporation Message API Version 1 (1.4.2)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-message-api-v1
Commands
Healthz
Get
Returns the application health status
ns-message healthz get
Value
List
Returns the value list of a given table and column
ns-message value list {table} {column}
Message
List
Returns the message list
ns-message message list {filters} {page} {size}
GetNewCount
Returns new messages info
ns-message message getnewcount
Get
Returns a message by an id
ns-message message get {id}
Create
Creates a new message
ns-message message create
--user_id (String)
--product_id (String)
--workspace_id (String)
--title (String)
--body (String)
SeenAll
Marks all unseen messages as seen.
ns-message message seenall
Seen
Marks a message as seen by id.
ns-message message seen {id}
Schemas
Message
{ "name": "Message", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "allowEmpty": false }, "user_id": { "type": "String", "required": true, "allowEmpty": false }, "product_id": { "type": "String", "required": false, "allowEmpty": true }, "workspace_id": { "type": "String", "required": false, "allowEmpty": true }, "title": { "type": "String", "required": true, "allowEmpty": false }, "body": { "type": "String", "required": true, "allowEmpty": false }, "created_at": { "type": "DateTime", "required": true }, "seen_at": { "type": "DateTime", "required": false } }}
MessageInput
{ "name": "MessageInput", "type": "Object", "required": true, "fields": { "user_id": { "type": "String", "required": true, "allowEmpty": false }, "product_id": { "type": "String", "required": false, "allowEmpty": true }, "workspace_id": { "type": "String", "required": false, "allowEmpty": true }, "title": { "type": "String", "required": true, "allowEmpty": false }, "body": { "type": "String", "required": true, "allowEmpty": false } }}
Enums
Namira Software Corporation
©Copyright 2010 to 2024 Namira Software Corporation. All rights reserved.