Namirasoft Support API V1

Namira Software Corporation Support API Version 1 (1.4.1)

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


Healthz

Get

Returns the application health status

ns-support healthz get

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!

Category

List

Returns the category list

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

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}

Copied!

Get

Returns a ticket by an id

ns-support ticket get {id}

Copied!

Create

Creates a new ticket

ns-support ticket create

Copied!

--category_id (Integer)

--title (String)

--priority (Enum)

--description (String)

Update

Updates a ticket by an id

ns-support ticket update {id}

Copied!

--category_id (Integer)

--title (String)

--priority (Enum)

--description (String)

Delete

Deletes a ticket by an id

ns-support ticket delete {id}

Copied!

Message

List

Returns the message list

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

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)

Update

Updates a message by an id

ns-support message update {id}

Copied!

--ticket_id (String)

--sender_id (String)

--message (String)

--ticket_resolved (Boolean)

Delete

Deletes a message by an id

ns-support message delete {id}

Copied!

Schemas


Category

{
  "name": "Category",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "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
    },
    "category_id": {
      "type": "Integer",
      "required": true
    },
    "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": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

TicketInput

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

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 2025 Namira Software Corporation. All rights reserved.