Namirasoft Support API V1

Namira Software Corporation Support API Version 1 (1.5.2)

Install


To use this cli, we need to first Install Nodejs, then run the following command.

npm i -g namirasoft-support-api-v1

Copied!

Commands


Health

Liveness

Returns the application liveness status

ns-support health liveness

Copied!

Readiness

Returns the application readiness status

ns-support health readiness

Copied!

Metrics

Get

Returns the application metrics

ns-support metrics get

Copied!

Value

List

Returns the value list of a given table and column

ns-support value list {table} {column} {search} {field_id} {limit}

Copied!

Overview

Count

Returns the row count of every entity across all databases, optionally grouped by workspace_id and filtered to specific workspaces

ns-support overview count

Copied!

--group_by_workspace (Boolean)

--workspace_ids (Array)

Category

List

Returns the category list

ns-support category list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a category by an id

ns-support category get {id}

Copied!

Ticket

List

Returns the ticket list

ns-support ticket list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a ticket by an id

ns-support ticket get {id}

Copied!

Create

Creates a new ticket

ns-support ticket create

Copied!

--product_id (String)

--category_id (String)

--resource_id (String)

--title (String)

--priority (Enum)

--description (String)

Resolved

Updates a status to resolved by an id

ns-support ticket resolved {id}

Copied!

Message

List

Returns the message list

ns-support message list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a message by an id

ns-support message get {id}

Copied!

Create

Creates a new message

ns-support message create

Copied!

--ticket_id (String)

--sender_id (String)

--message (String)

--ticket_resolved (Boolean)

Schemas


OverviewCountInput

{
    "name": "OverviewCountInput",
    "type": "Object",
    "required": true,
    "fields": {
        "group_by_workspace": {
            "type": "Boolean",
            "required": false
        },
        "workspace_ids": {
            "type": "Array",
            "required": false,
            "items": [
                {
                    "type": "String",
                    "required": true
                }
            ]
        }
    }
}

OverviewCountRow

{
    "name": "OverviewCountRow",
    "type": "Object",
    "required": true,
    "fields": {
        "database": {
            "type": "String",
            "required": true
        },
        "table": {
            "type": "String",
            "required": true
        },
        "total": {
            "type": "Integer",
            "required": true
        },
        "by_workspace": {
            "type": "Array",
            "required": false,
            "items": [
                {
                    "name": "OverviewCountByWorkspace",
                    "type": "Object",
                    "required": true,
                    "fields": {
                        "workspace_id": {
                            "type": "String",
                            "required": true
                        },
                        "count": {
                            "type": "Integer",
                            "required": true
                        }
                    }
                }
            ]
        }
    }
}

OverviewCountByWorkspace

{
    "name": "OverviewCountByWorkspace",
    "type": "Object",
    "required": true,
    "fields": {
        "workspace_id": {
            "type": "String",
            "required": true
        },
        "count": {
            "type": "Integer",
            "required": true
        }
    }
}

Category

{
    "name": "Category",
    "type": "Object",
    "required": true,
    "fields": {
        "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
        }
    }
}

Ticket

{
    "name": "Ticket",
    "type": "Object",
    "required": true,
    "fields": {
        "id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "user_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "product_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "category_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "resource_id": {
            "type": "String",
            "required": false,
            "min": 20,
            "max": 20
        },
        "last_sender_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "title": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "status": {
            "name": "TicketStatus",
            "type": "Enum",
            "required": true,
            "valids": [
                "Open",
                "InProgress",
                "Resolved",
                "Closed"
            ]
        },
        "priority": {
            "name": "TicketPriority",
            "type": "Enum",
            "required": true,
            "valids": [
                "Low",
                "Medium",
                "High",
                "Urgent"
            ]
        },
        "assignee": {
            "name": "TicketAssignee",
            "type": "Enum",
            "required": true,
            "valids": [
                "ReadOnly"
            ]
        },
        "description": {
            "type": "String",
            "required": true
        },
        "created_at": {
            "type": "DateTime",
            "required": true
        },
        "updated_at": {
            "type": "DateTime",
            "required": true
        }
    }
}

TicketInput

{
    "name": "TicketInput",
    "type": "Object",
    "required": true,
    "fields": {
        "product_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "category_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "resource_id": {
            "type": "String",
            "required": false,
            "min": 20,
            "max": 20
        },
        "title": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "priority": {
            "name": "TicketPriority",
            "type": "Enum",
            "required": true,
            "valids": [
                "Low",
                "Medium",
                "High",
                "Urgent"
            ]
        },
        "description": {
            "type": "String",
            "required": true
        }
    }
}

Message

{
    "name": "Message",
    "type": "Object",
    "required": true,
    "fields": {
        "id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "user_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "ticket_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "sender_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "message": {
            "type": "String",
            "required": true
        },
        "created_at": {
            "type": "DateTime",
            "required": true
        },
        "updated_at": {
            "type": "DateTime",
            "required": true
        }
    }
}

MessageInput

{
    "name": "MessageInput",
    "type": "Object",
    "required": true,
    "fields": {
        "ticket_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "sender_id": {
            "type": "String",
            "required": true,
            "min": 20,
            "max": 20
        },
        "message": {
            "type": "String",
            "required": true
        },
        "ticket_resolved": {
            "type": "Boolean",
            "required": true
        }
    }
}

Enums

TicketStatus

Open

InProgress

Resolved

Closed

TicketPriority

Low

Medium

High

Urgent

TicketAssignee

ReadOnly

Namira Software Corporation

©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.