Namirasoft Job Arranger API V1
Namira Software Corporation Job Arranger API Version 1 (1.4.30)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-job-arranger-api-v1
Commands
Healthz
Get
Returns the application health status
ns-job-arranger healthz get
Value
List
Returns the value list of a given table and column
ns-job-arranger value list {table} {column}
Company
List
Returns the company list
ns-job-arranger company list
GetDashboard
Returns a dashboard company
ns-job-arranger company getdashboard {company}
Job
List
Returns the job list
ns-job-arranger job list {filters} {page} {size} {sorts} {user_id}
Get
Returns a job by an id
ns-job-arranger job get {id}
Set
Sets a job by an id or sid
ns-job-arranger job set {id_sid}
--sid (String)
--platform_id (Integer)
--reason_id (String)
--url (String)
--name (String)
--company (String)
--location (String)
--remote (String)
--min (Integer)
--max (Integer)
--status (Enum)
Delete
Deletes a job by an id
ns-job-arranger job delete {id}
Location
List
Returns the location list
ns-job-arranger location list {filters} {page} {size} {sorts} {user_id}
Platform
List
Returns the platform list
ns-job-arranger platform list {filters} {page} {size} {sorts} {user_id}
Reason
List
Returns the reason list
ns-job-arranger reason list {filters} {page} {size} {sorts} {user_id}
Get
Returns a reason by an id
ns-job-arranger reason get {id}
Create
Creates a new reason
ns-job-arranger reason create
--name (String)
--status (Enum)
Update
Updates a reason by an id
ns-job-arranger reason update {id}
--name (String)
--status (Enum)
Delete
Deletes a reason by an id
ns-job-arranger reason delete {id}
Remote
List
Returns the remote list
ns-job-arranger remote list {filters} {page} {size} {sorts} {user_id}
User
Dashboard
Gets user dashboard
ns-job-arranger user dashboard
GetCredit
Returns the current user's credit
ns-job-arranger user getcredit
Get
Returns an user
ns-job-arranger user get
Schemas
Dashboard
{ "name": "Dashboard", "type": "Object", "required": true, "fields": { "byStatus": { "type": "Array", "required": true, "items": [ { "name": "DashboardItem", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "allowEmpty": false }, "icon": { "type": "String", "required": true, "allowEmpty": false }, "count": { "type": "Integer", "required": true } } } ] }, "byPlatform": { "type": "Array", "required": true, "items": [ { "name": "DashboardItem", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "allowEmpty": false }, "icon": { "type": "String", "required": true, "allowEmpty": false }, "count": { "type": "Integer", "required": true } } } ] }, "jobs": { "type": "Array", "required": true, "items": [ { "name": "Job", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20, "allowEmpty": false }, "sid": { "type": "String", "required": true, "allowEmpty": false }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20, "allowEmpty": false }, "platform_id": { "type": "Integer", "required": true }, "reason_id": { "type": "String", "required": false, "min": 20, "max": 20, "allowEmpty": true }, "url": { "type": "String", "required": true, "allowEmpty": false }, "name": { "type": "String", "required": true, "allowEmpty": false }, "company": { "type": "String", "required": true, "allowEmpty": false }, "location": { "type": "String", "required": true, "allowEmpty": false }, "remote": { "type": "String", "required": false, "allowEmpty": true }, "min": { "type": "Integer", "required": false }, "max": { "type": "Integer", "required": false }, "status": { "name": "JobStatus", "type": "Enum", "required": true, "valids": [ "BlackList", "WhiteList", "Emailed", "Applied", "Replied", "Interviewed", "Rejected", "Hired" ] }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } ] } }}
DashboardItem
{ "name": "DashboardItem", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "allowEmpty": false }, "icon": { "type": "String", "required": true, "allowEmpty": false }, "count": { "type": "Integer", "required": true } }}
Job
{ "name": "Job", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20, "allowEmpty": false }, "sid": { "type": "String", "required": true, "allowEmpty": false }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20, "allowEmpty": false }, "platform_id": { "type": "Integer", "required": true }, "reason_id": { "type": "String", "required": false, "min": 20, "max": 20, "allowEmpty": true }, "url": { "type": "String", "required": true, "allowEmpty": false }, "name": { "type": "String", "required": true, "allowEmpty": false }, "company": { "type": "String", "required": true, "allowEmpty": false }, "location": { "type": "String", "required": true, "allowEmpty": false }, "remote": { "type": "String", "required": false, "allowEmpty": true }, "min": { "type": "Integer", "required": false }, "max": { "type": "Integer", "required": false }, "status": { "name": "JobStatus", "type": "Enum", "required": true, "valids": [ "BlackList", "WhiteList", "Emailed", "Applied", "Replied", "Interviewed", "Rejected", "Hired" ] }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
JobInput
{ "name": "JobInput", "type": "Object", "required": true, "fields": { "sid": { "type": "String", "required": true, "allowEmpty": false }, "platform_id": { "type": "Integer", "required": true }, "reason_id": { "type": "String", "required": false, "min": 20, "max": 20, "allowEmpty": true }, "url": { "type": "String", "required": true, "allowEmpty": false }, "name": { "type": "String", "required": true, "allowEmpty": false }, "company": { "type": "String", "required": true, "allowEmpty": false }, "location": { "type": "String", "required": true, "allowEmpty": false }, "remote": { "type": "String", "required": false, "allowEmpty": true }, "min": { "type": "Integer", "required": false }, "max": { "type": "Integer", "required": false }, "status": { "name": "JobStatus", "type": "Enum", "required": true, "valids": [ "BlackList", "WhiteList", "Emailed", "Applied", "Replied", "Interviewed", "Rejected", "Hired" ] } }}
Platform
{ "name": "Platform", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "allowEmpty": false }, "site": { "type": "String", "required": true, "allowEmpty": false }, "icon": { "type": "String", "required": true, "allowEmpty": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Reason
{ "name": "Reason", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20, "allowEmpty": false }, "user_id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "allowEmpty": false }, "status": { "name": "ReasonStatus", "type": "Enum", "required": true, "valids": [ "BlackList", "WhiteList", "Emailed", "Applied", "Replied", "Interviewed", "Rejected", "Hired" ] }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
ReasonInput
{ "name": "ReasonInput", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "allowEmpty": false }, "status": { "name": "ReasonStatus", "type": "Enum", "required": true, "valids": [ "BlackList", "WhiteList", "Emailed", "Applied", "Replied", "Interviewed", "Rejected", "Hired" ] } }}
Credit
{ "name": "Credit", "type": "Object", "required": true, "fields": { "valid_to": { "type": "String", "required": false, "allowEmpty": true }, "delay": { "type": "Integer", "required": true }, "delay_remained": { "type": "Integer", "required": true } }}
User
{ "name": "User", "type": "Object", "required": false, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20, "allowEmpty": false }, "valid_to": { "type": "DateTime", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Enums
JobStatus
BlackList
WhiteList
Emailed
Applied
Replied
Interviewed
Rejected
Hired
ReasonStatus
BlackList
WhiteList
Emailed
Applied
Replied
Interviewed
Rejected
Hired
Namira Software Corporation
©Copyright 2010 to 2024 Namira Software Corporation. All rights reserved.