Namirasoft Account API V1

Namira Software Corporation Account API Version 1 (1.4.20)

Install


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

npm i -g namirasoft-account-api-v1

Copied!

Commands


Healthz

Get

Returns the application health status

ns-account healthz get

Copied!

Value

List

Returns the value list of a given table and column

ns-account value list {table} {column}

Copied!

Country

List

Returns the country list

ns-account country list

Copied!

Email

Request

Email request

ns-account email request

Copied!

Verify

Verify email

ns-account email verify

Copied!

--code (String)

Password

Forget

Forget password

ns-account password forget

Copied!

--email (Email)

New

New password

ns-account password new

Copied!

--user_id (String)

--hash (String)

--pass_new (String)

--pass_rep (String)

Reset

Reset password

ns-account password reset

Copied!

--pass_cur (String)

--pass_new (String)

--pass_rep (String)

Phone

Request

Sends a phone validation request by SMS

ns-account phone request

Copied!

Verify

Verify phone

ns-account phone verify

Copied!

--code (String)

SessionCategory

List

Returns the session category list

ns-account sessioncategory list {filters} {page} {size}

Copied!

Get

Returns a session category by id.

ns-account sessioncategory get {id}

Copied!

Create

Creates a new session category

ns-account sessioncategory create

Copied!

--entity_id (String)

--category_id (String)

Delete

Deletes a session category by an id.

ns-account sessioncategory delete {id}

Copied!

SessionField

List

Returns the session field list

ns-account sessionfield list {filters} {page} {size}

Copied!

Get

Returns a session field by id.

ns-account sessionfield get {id}

Copied!

Create

Creates a new session field

ns-account sessionfield create

Copied!

--entity_id (String)

--field_id (String)

--value (String)

--description (String)

Update

Updates a session field by an id

ns-account sessionfield update {id}

Copied!

--entity_id (String)

--field_id (String)

--value (String)

--description (String)

Delete

Deletes a session field by an id.

ns-account sessionfield delete {id}

Copied!

SessionTag

List

Returns the session tag list

ns-account sessiontag list {filters} {page} {size}

Copied!

Get

Returns a session tag by id.

ns-account sessiontag get {id}

Copied!

Create

Creates a new session tag

ns-account sessiontag create

Copied!

--entity_id (String)

--name (String)

--value (String)

--description (String)

Update

Updates a session tag by an id

ns-account sessiontag update {id}

Copied!

--entity_id (String)

--name (String)

--value (String)

--description (String)

Delete

Deletes a session tag by an id.

ns-account sessiontag delete {id}

Copied!

Session

Login

Logins and Returns a new session

ns-account session login

Copied!

--email (Email)

--password (String)

--os (String)

Logout

Logout from the current session

ns-account session logout

Copied!

Current

Signs the current session.

ns-account session current

Copied!

List

Returns the session list

ns-account session list {filters} {page} {size} {user_id}

Copied!

Get

Returns a session by an id

ns-account session get {id}

Copied!

Delete

Deletes a session by an id

ns-account session delete {id}

Copied!

UserCategory

List

Returns the user category list

ns-account usercategory list {filters} {page} {size}

Copied!

Get

Returns a user category by id.

ns-account usercategory get {id}

Copied!

Create

Creates a new user category

ns-account usercategory create

Copied!

--entity_id (String)

--category_id (String)

Delete

Deletes a user category by an id.

ns-account usercategory delete {id}

Copied!

UserField

List

Returns the user field list

ns-account userfield list {filters} {page} {size}

Copied!

Get

Returns a user field by id.

ns-account userfield get {id}

Copied!

Create

Creates a new user field

ns-account userfield create

Copied!

--entity_id (String)

--field_id (String)

--value (String)

--description (String)

Update

Updates a user field by an id

ns-account userfield update {id}

Copied!

--entity_id (String)

--field_id (String)

--value (String)

--description (String)

Delete

Deletes a user field by an id.

ns-account userfield delete {id}

Copied!

UserTag

List

Returns the user tag list

ns-account usertag list {filters} {page} {size}

Copied!

Get

Returns a user tag by id.

ns-account usertag get {id}

Copied!

Create

Creates a new user tag

ns-account usertag create

Copied!

--entity_id (String)

--name (String)

--value (String)

--description (String)

Update

Updates a user tag by an id

ns-account usertag update {id}

Copied!

--entity_id (String)

--name (String)

--value (String)

--description (String)

Delete

Deletes a user tag by an id.

ns-account usertag delete {id}

Copied!

User

Current

Returns the user

ns-account user current

Copied!

Register

registers a user

ns-account user register

Copied!

--first_name (String)

--last_name (String)

--country (String)

--email (Email)

--phone (String)

--birthday (Date)

--password (String)

--os (String)

Get

Returns an user by an id

ns-account user get {id}

Copied!

Google

User google

ns-account user google

Copied!

--client_id (String)

--credential (String)

--os (String)

Banned

Banned an user by an id

ns-account user banned {id}

Copied!

Cancel

Cancels the user deletion

ns-account user cancel

Copied!

Update

Updates the current user

ns-account user update

Copied!

--first_name (String)

--last_name (String)

--email (Email)

--phone (String)

--birthday (Date)

Delete

Marks the current user for deletion

ns-account user delete

Copied!

ServiceUser

List

Returns the service user list

ns-account serviceuser list {filters} {page} {size} {user_id}

Copied!

Get

Returns a service user by an id

ns-account serviceuser get {id}

Copied!

Create

Creates a new service user

ns-account serviceuser create

Copied!

--name (String)

Update

Updates a service user by an id

ns-account serviceuser update {id}

Copied!

--name (String)

Delete

Deletes a service user by an id

ns-account serviceuser delete {id}

Copied!

ServiceSession

List

Returns the service session list

ns-account servicesession list {filters} {page} {size} {user_id}

Copied!

Get

Returns a service session by an id

ns-account servicesession get {id}

Copied!

Create

Creates a new service session

ns-account servicesession create

Copied!

--user_id (String)

--name (String)

--os (String)

Delete

Deletes a service session by an id

ns-account servicesession delete {id}

Copied!

NotificationSetting

List

Returns the notification setting list

ns-account notificationsetting list

Copied!

Set

Updates notification settings

ns-account notificationsetting set

Copied!

--email (Array)

--sms (Array)

--message (Array)

Schemas


Country

{
  "name": "Country",
  "type": "Object",
  "required": true
}

SessionCategory

{
  "name": "SessionCategory",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "category_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityCategoryInput

{
  "name": "EntityCategoryInput",
  "type": "Object",
  "required": true,
  "fields": {
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "category_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    }
  }
}

SessionField

{
  "name": "SessionField",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "value": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityFieldInput

{
  "name": "EntityFieldInput",
  "type": "Object",
  "required": true,
  "fields": {
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "value": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    }
  }
}

SessionTag

{
  "name": "SessionTag",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "name": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "value": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityTagInput

{
  "name": "EntityTagInput",
  "type": "Object",
  "required": true,
  "fields": {
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "name": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "value": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    }
  }
}

SessionLogin

{
  "name": "SessionLogin",
  "type": "Object",
  "required": true,
  "fields": {
    "email": {
      "type": "Email",
      "required": true
    },
    "password": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "os": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    }
  }
}

NamirasoftAccountToken

{
  "name": "NamirasoftAccountToken",
  "type": "Object",
  "required": true
}

Session

{
  "name": "Session",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "name": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "os": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "ip": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "continent": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "country": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "city": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

UserCategory

{
  "name": "UserCategory",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "category_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

UserField

{
  "name": "UserField",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "value": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

UserTag

{
  "name": "UserTag",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "name": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "value": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "description": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

User

{
  "name": "User",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "user_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20,
      "allowEmpty": true
    },
    "first_name": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "last_name": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "country_code": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "country": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "email": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "phone": {
      "type": "String",
      "required": false,
      "max": 15,
      "allowEmpty": true
    },
    "birthday": {
      "type": "DateTime",
      "required": false
    },
    "tester": {
      "type": "Boolean",
      "required": true
    },
    "approved": {
      "type": "Boolean",
      "required": true
    },
    "approved_reason": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "banned": {
      "type": "Boolean",
      "required": true
    },
    "banned_reason": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "premium": {
      "type": "Boolean",
      "required": true
    },
    "premium_reason": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "notification_setting": {
      "type": "Any",
      "required": false
    },
    "e_approved": {
      "type": "Boolean",
      "required": true
    },
    "p_approved": {
      "type": "Boolean",
      "required": true
    },
    "will_be_deleted_at": {
      "type": "DateTime",
      "required": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

UserCreate

{
  "name": "UserCreate",
  "type": "Object",
  "required": true,
  "fields": {
    "first_name": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "last_name": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "country": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "email": {
      "type": "Email",
      "required": true
    },
    "phone": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "birthday": {
      "type": "Date",
      "required": false
    },
    "password": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "os": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    }
  }
}

UserCreateByGoogle

{
  "name": "UserCreateByGoogle",
  "type": "Object",
  "required": true,
  "fields": {
    "client_id": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "credential": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    },
    "os": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    }
  }
}

UserUpdate

{
  "name": "UserUpdate",
  "type": "Object",
  "required": true,
  "fields": {
    "first_name": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "last_name": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "email": {
      "type": "Email",
      "required": false
    },
    "phone": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "birthday": {
      "type": "Date",
      "required": false
    }
  }
}

ServiceUserInput

{
  "name": "ServiceUserInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "allowEmpty": false
    }
  }
}

ServiceSessionCreate

{
  "name": "ServiceSessionCreate",
  "type": "Object",
  "required": true,
  "fields": {
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20,
      "allowEmpty": false
    },
    "name": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    },
    "os": {
      "type": "String",
      "required": false,
      "allowEmpty": true
    }
  }
}

NotificationSetting

{
  "name": "NotificationSetting",
  "type": "Object",
  "required": true,
  "fields": {
    "email": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "type": "String",
          "required": false,
          "allowEmpty": true
        }
      ]
    },
    "sms": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "type": "String",
          "required": false,
          "allowEmpty": true
        }
      ]
    },
    "message": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "type": "String",
          "required": false,
          "allowEmpty": true
        }
      ]
    }
  }
}

Enums

Namira Software Corporation

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