Namirasoft Account API V1
Namira Software Corporation Account API Version 1 (1.5.8)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-account-api-v1
Commands
Health
Liveness
Returns the application liveness status
ns-account health liveness
Readiness
Returns the application readiness status
ns-account health readiness
Metrics
Get
Returns the application metrics
ns-account metrics get
Value
List
Returns the value list of a given table and column
ns-account value list {table} {column} {search} {field_id} {limit}
Overview
Count
Returns the row count of every entity across all databases, optionally grouped by workspace_id and filtered to specific workspaces
ns-account overview count
--group_by_workspace (Boolean)
--workspace_ids (Array)
Country
List
Returns the country list
ns-account country list
Request
Email request
ns-account email request
Verify
Verify email
ns-account email verify
--code (String)
Set
Set email
ns-account email set
--email (String)
Password
Forget
Forget password
ns-account password forget
--email (Email)
New
New password
ns-account password new
--user_id (String)
--hash (String)
--pass_new (String)
--pass_rep (String)
Reset
Reset password
ns-account password reset
--pass_cur (String)
--pass_new (String)
--pass_rep (String)
Phone
Request
Sends a phone validation request by SMS
ns-account phone request
Verify
Verify phone
ns-account phone verify
--code (String)
Set
Set phone
ns-account phone set
--phone (String)
Consent
GetByProduct
Returns a consent by a product_id
ns-account consent getbyproduct {product_id}
Get
Returns a consent by an id
ns-account consent get {id}
Set
Sets and Returns a consent
ns-account consent set
--product_id (String)
Create
Creates a new consent
ns-account consent create
--product_id (String)
SessionCategory
List
Returns the session category list
ns-account sessioncategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a session category by id.
ns-account sessioncategory get {id}
Create
Creates a new session category for an entity
ns-account sessioncategory create
--slot_id (String)
--category_id (String)
Delete
Deletes a session category by an id.
ns-account sessioncategory delete {id}
SessionField
List
Returns the session field list
ns-account sessionfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a session field by id.
ns-account sessionfield get {id}
Create
Creates a new session field for an entity
ns-account sessionfield create
--slot_id (String)
--field_id (String)
--value (Any)
Update
Updates a session field by an id for an entity
ns-account sessionfield update {id}
--slot_id (String)
--field_id (String)
--value (Any)
Delete
Deletes a session field by an id.
ns-account sessionfield delete {id}
SessionTag
List
Returns the session tag list
ns-account sessiontag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a session tag by id.
ns-account sessiontag get {id}
Create
Creates a new session tag for an entity
ns-account sessiontag create
--name (String)
--value (String)
Update
Updates a session tag by an id for an entity
ns-account sessiontag update {id}
--name (String)
--value (String)
Delete
Deletes a session tag by an id.
ns-account sessiontag delete {id}
Session
_List
Returns the session list for all user_id
ns-account session _list {filters} {page} {size} {sorts} {all_workspaces}
_SetOwnerFor
Sets the owner_id for a session_id
ns-account session _setownerfor {session_id}
--owner_id (String)
Login
Logins and Returns a new session
ns-account session login
--email (Email)
--password (String)
Logout
Logout from the current session
ns-account session logout
Current
Signs the current session.
ns-account session current
List
Returns the session list
ns-account session list {filters} {page} {size} {sorts} {all_workspaces}
GetToken
Returns a session token by an id
ns-account session gettoken {id}
Get
Returns a session by an id
ns-account session get {id}
_Sign
Signs a session by an id
ns-account session _sign {id}
Delete
Deletes a session by an id
ns-account session delete {id}
UserCategory
List
Returns the user category list
ns-account usercategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a user category by id.
ns-account usercategory get {id}
Create
Creates a new user category for an entity
ns-account usercategory create
--slot_id (String)
--category_id (String)
Delete
Deletes a user category by an id.
ns-account usercategory delete {id}
UserField
List
Returns the user field list
ns-account userfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a user field by id.
ns-account userfield get {id}
Create
Creates a new user field for an entity
ns-account userfield create
--slot_id (String)
--field_id (String)
--value (Any)
Update
Updates a user field by an id for an entity
ns-account userfield update {id}
--slot_id (String)
--field_id (String)
--value (Any)
Delete
Deletes a user field by an id.
ns-account userfield delete {id}
UserTag
List
Returns the user tag list
ns-account usertag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a user tag by id.
ns-account usertag get {id}
Create
Creates a new user tag for an entity
ns-account usertag create
--name (String)
--value (String)
Update
Updates a user tag by an id for an entity
ns-account usertag update {id}
--name (String)
--value (String)
Delete
Deletes a user tag by an id.
ns-account usertag delete {id}
User
Current
Returns the user
ns-account user current
Register
registers a user
ns-account user register
--first_name (String)
--last_name (String)
--country (String)
--email (Email)
--phone (String)
--birthday (String)
--password (String)
User google
ns-account user google
--client_id (String)
--credential (String)
--access_token (String)
Github
User github
ns-account user github
--client_id (String)
--code (String)
--access_token (String)
Banned
Banned an user by an id
ns-account user banned {id}
Cancel
Cancels the user deletion
ns-account user cancel
Update
Updates the current user
ns-account user update
--first_name (String)
--last_name (String)
--email (Email)
--phone (String)
--birthday (String)
Delete
Marks the current user for deletion
ns-account user delete
_GetByEmail
Returns an user by an email
ns-account user _getbyemail {email}
GetShort
Returns the short of an user by an id
ns-account user getshort {id}
_Get
Returns an user by an id
ns-account user _get {id}
Dashboard
_Lifecycle
Returns aggregated user lifecycle counts (signups and deletions, totals and daily buckets)
ns-account dashboard _lifecycle
ServiceUser
List
Returns the service user list
ns-account serviceuser list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a service user by an id
ns-account serviceuser get {id}
Create
Creates a new service user
ns-account serviceuser create
--name (String)
--user_category (Array)
--user_field (Array)
--user_tag (Array)
Update
Updates a service user by an id
ns-account serviceuser update {id}
--name (String)
--user_category (Array)
--user_field (Array)
--user_tag (Array)
Delete
Deletes a service user by an id
ns-account serviceuser delete {id}
_DeleteFor
Deletes a service user by an id
ns-account serviceuser _deletefor {id}
ServiceSession
List
Returns the service session list
ns-account servicesession list {filters} {page} {size} {sorts} {all_workspaces}
GetToken
Returns a service session token by an id
ns-account servicesession gettoken {id}
Get
Returns a service session by an id
ns-account servicesession get {id}
Create
Creates a new service session
ns-account servicesession create
--user_id (String)
--name (String)
--session_category (Array)
--session_field (Array)
--session_tag (Array)
Delete
Deletes a service session by an id
ns-account servicesession delete {id}
_DeleteFor
Deletes a service session by an id for an user_id
ns-account servicesession _deletefor {user_id} {id}
NotificationSetting
List
Returns the notification setting list
ns-account notificationsetting list
Set
Updates notification settings
ns-account notificationsetting set
--body (Any)
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 } }}
Country
{ "name": "Country", "type": "Object", "required": true}
UserFull
{ "name": "UserFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "first_name": { "type": "String", "required": true, "max": 255 }, "last_name": { "type": "String", "required": true, "max": 255 }, "country_code": { "type": "String", "required": true, "max": 255 }, "country": { "type": "String", "required": true, "max": 255 }, "email": { "type": "String", "required": true, "max": 255 }, "phone": { "type": "String", "required": false, "max": 15 }, "phone_temporary": { "type": "String", "required": false, "max": 15 }, "picture": { "type": "String", "required": false }, "birthday": { "type": "Date", "required": false }, "tester": { "type": "Boolean", "required": true }, "approved": { "type": "Boolean", "required": true }, "approved_reason": { "type": "String", "required": false }, "banned": { "type": "Boolean", "required": true }, "banned_reason": { "type": "String", "required": false }, "premium": { "type": "Boolean", "required": true }, "premium_reason": { "type": "String", "required": false }, "notification_setting": { "type": "Any", "required": false }, "e_verified": { "type": "Boolean", "required": true }, "p_verified": { "type": "Boolean", "required": true }, "will_be_deleted_at": { "type": "DateTime", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "user_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "user_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "user_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
EntityCategoryInput
{ "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } }}
EntityFieldInput
{ "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } }}
EntityTagInput
{ "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } }}
Consent
{ "name": "Consent", "type": "Object", "required": false, "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 }, "os": { "type": "String", "required": false, "max": 255 }, "ip": { "type": "String", "required": false, "max": 255 }, "continent": { "type": "String", "required": false, "max": 255 }, "country": { "type": "String", "required": false, "max": 255 }, "city": { "type": "String", "required": false, "max": 255 }, "terms_version": { "type": "String", "required": false, "max": 255 }, "privacy_version": { "type": "String", "required": false, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
ConsentInput
{ "name": "ConsentInput", "type": "Object", "required": true, "fields": { "product_id": { "type": "String", "required": true, "min": 20, "max": 20 } }}
SessionCategory
{ "name": "SessionCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
SessionField
{ "name": "SessionField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
SessionTag
{ "name": "SessionTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Session
{ "name": "Session", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "owner_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": false, "max": 255 }, "user_agent": { "type": "String", "required": false, "max": 255 }, "browser_name": { "type": "String", "required": false, "max": 255 }, "browser_type": { "type": "String", "required": false, "max": 255 }, "browser_version": { "type": "String", "required": false, "max": 255 }, "browser_major": { "type": "String", "required": false, "max": 255 }, "cpu_architecture": { "type": "String", "required": false, "max": 255 }, "device_model": { "type": "String", "required": false, "max": 255 }, "device_type": { "type": "String", "required": false, "max": 255 }, "device_vendor": { "type": "String", "required": false, "max": 255 }, "engine_name": { "type": "String", "required": false, "max": 255 }, "engine_version": { "type": "String", "required": false, "max": 255 }, "os_name": { "type": "String", "required": false, "max": 255 }, "os_version": { "type": "String", "required": false, "max": 255 }, "os": { "type": "String", "required": false, "max": 255 }, "ip": { "type": "String", "required": false, "max": 255 }, "continent": { "type": "String", "required": false, "max": 255 }, "country": { "type": "String", "required": false, "max": 255 }, "city": { "type": "String", "required": false, "max": 255 }, "last_access_at": { "type": "DateTime", "required": false }, "last_access_product_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "last_access_entity": { "type": "String", "required": false, "max": 255 }, "last_access_action": { "type": "String", "required": false, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
SessionLogin
{ "name": "SessionLogin", "type": "Object", "required": true, "fields": { "email": { "regex": {}, "type": "Email", "required": true }, "password": { "type": "String", "required": true } }}
NamirasoftAccountToken
{ "name": "NamirasoftAccountToken", "type": "Object", "required": true}
SessionFull
{ "name": "SessionFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "owner_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": false, "max": 255 }, "user_agent": { "type": "String", "required": false, "max": 255 }, "browser_name": { "type": "String", "required": false, "max": 255 }, "browser_type": { "type": "String", "required": false, "max": 255 }, "browser_version": { "type": "String", "required": false, "max": 255 }, "browser_major": { "type": "String", "required": false, "max": 255 }, "cpu_architecture": { "type": "String", "required": false, "max": 255 }, "device_model": { "type": "String", "required": false, "max": 255 }, "device_type": { "type": "String", "required": false, "max": 255 }, "device_vendor": { "type": "String", "required": false, "max": 255 }, "engine_name": { "type": "String", "required": false, "max": 255 }, "engine_version": { "type": "String", "required": false, "max": 255 }, "os_name": { "type": "String", "required": false, "max": 255 }, "os_version": { "type": "String", "required": false, "max": 255 }, "os": { "type": "String", "required": false, "max": 255 }, "ip": { "type": "String", "required": false, "max": 255 }, "continent": { "type": "String", "required": false, "max": 255 }, "country": { "type": "String", "required": false, "max": 255 }, "city": { "type": "String", "required": false, "max": 255 }, "last_access_at": { "type": "DateTime", "required": false }, "last_access_product_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "last_access_entity": { "type": "String", "required": false, "max": 255 }, "last_access_action": { "type": "String", "required": false, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "session_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "session_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "session_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
UserCategory
{ "name": "UserCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "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 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "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 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "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 }, "user_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "first_name": { "type": "String", "required": true, "max": 255 }, "last_name": { "type": "String", "required": true, "max": 255 }, "country_code": { "type": "String", "required": true, "max": 255 }, "country": { "type": "String", "required": true, "max": 255 }, "email": { "type": "String", "required": true, "max": 255 }, "phone": { "type": "String", "required": false, "max": 15 }, "phone_temporary": { "type": "String", "required": false, "max": 15 }, "picture": { "type": "String", "required": false }, "birthday": { "type": "Date", "required": false }, "tester": { "type": "Boolean", "required": true }, "approved": { "type": "Boolean", "required": true }, "approved_reason": { "type": "String", "required": false }, "banned": { "type": "Boolean", "required": true }, "banned_reason": { "type": "String", "required": false }, "premium": { "type": "Boolean", "required": true }, "premium_reason": { "type": "String", "required": false }, "notification_setting": { "type": "Any", "required": false }, "e_verified": { "type": "Boolean", "required": true }, "p_verified": { "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 }, "last_name": { "type": "String", "required": true }, "country": { "type": "String", "required": true }, "email": { "regex": {}, "type": "Email", "required": true }, "phone": { "type": "String", "required": false }, "birthday": { "type": "String", "required": false }, "password": { "type": "String", "required": true } }}
UserCreateByGoogle
{ "name": "UserCreateByGoogle", "type": "Object", "required": true, "fields": { "client_id": { "type": "String", "required": false }, "credential": { "type": "String", "required": false }, "access_token": { "type": "String", "required": false } }}
UserCreateByGithub
{ "name": "UserCreateByGithub", "type": "Object", "required": true, "fields": { "client_id": { "type": "String", "required": false }, "code": { "type": "String", "required": false }, "access_token": { "type": "String", "required": false } }}
UserUpdate
{ "name": "UserUpdate", "type": "Object", "required": true, "fields": { "first_name": { "type": "String", "required": false }, "last_name": { "type": "String", "required": false }, "email": { "regex": {}, "type": "Email", "required": false }, "phone": { "type": "String", "required": false }, "birthday": { "type": "String", "required": false } }}
UserShort
{ "name": "UserShort", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true }, "user_id": { "type": "String", "required": false }, "first_name": { "type": "String", "required": true }, "last_name": { "type": "String", "required": true } }}
UserLifecycle
{ "name": "UserLifecycle", "type": "Object", "required": true, "fields": { "new": { "name": "UserLifecycleNew", "type": "Object", "required": true, "fields": { "total": { "type": "Integer", "required": true }, "last_day": { "type": "Integer", "required": true }, "last_week": { "type": "Integer", "required": true }, "last_month": { "type": "Integer", "required": true }, "daily": { "type": "Array", "required": true, "items": [ { "name": "UserLifecycleDailyBucket", "type": "Object", "required": true, "fields": { "date": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } } } ] } } }, "active": { "name": "UserLifecycleActive", "type": "Object", "required": true, "fields": { "total": { "type": "Integer", "required": true }, "last_day": { "type": "Integer", "required": true }, "last_week": { "type": "Integer", "required": true }, "last_month": { "type": "Integer", "required": true }, "daily": { "type": "Array", "required": true, "items": [ { "name": "UserLifecycleDailyBucket", "type": "Object", "required": true, "fields": { "date": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } } } ] } } }, "deleted": { "name": "UserLifecycleDeleted", "type": "Object", "required": true, "fields": { "total": { "type": "Integer", "required": true }, "will_be_deleted_next_day": { "type": "Integer", "required": true }, "will_be_deleted_next_week": { "type": "Integer", "required": true }, "will_be_deleted_next_month": { "type": "Integer", "required": true }, "daily_will_be_deleted": { "type": "Array", "required": true, "items": [ { "name": "UserLifecycleDailyBucket", "type": "Object", "required": true, "fields": { "date": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } } } ] } } } }}
UserLifecycleNew
{ "name": "UserLifecycleNew", "type": "Object", "required": true, "fields": { "total": { "type": "Integer", "required": true }, "last_day": { "type": "Integer", "required": true }, "last_week": { "type": "Integer", "required": true }, "last_month": { "type": "Integer", "required": true }, "daily": { "type": "Array", "required": true, "items": [ { "name": "UserLifecycleDailyBucket", "type": "Object", "required": true, "fields": { "date": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } } } ] } }}
UserLifecycleDailyBucket
{ "name": "UserLifecycleDailyBucket", "type": "Object", "required": true, "fields": { "date": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } }}
UserLifecycleActive
{ "name": "UserLifecycleActive", "type": "Object", "required": true, "fields": { "total": { "type": "Integer", "required": true }, "last_day": { "type": "Integer", "required": true }, "last_week": { "type": "Integer", "required": true }, "last_month": { "type": "Integer", "required": true }, "daily": { "type": "Array", "required": true, "items": [ { "name": "UserLifecycleDailyBucket", "type": "Object", "required": true, "fields": { "date": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } } } ] } }}
UserLifecycleDeleted
{ "name": "UserLifecycleDeleted", "type": "Object", "required": true, "fields": { "total": { "type": "Integer", "required": true }, "will_be_deleted_next_day": { "type": "Integer", "required": true }, "will_be_deleted_next_week": { "type": "Integer", "required": true }, "will_be_deleted_next_month": { "type": "Integer", "required": true }, "daily_will_be_deleted": { "type": "Array", "required": true, "items": [ { "name": "UserLifecycleDailyBucket", "type": "Object", "required": true, "fields": { "date": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } } } ] } }}
ServiceUserInput
{ "name": "ServiceUserInput", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "user_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "user_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "user_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
ServiceSessionCreate
{ "name": "ServiceSessionCreate", "type": "Object", "required": true, "fields": { "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": false, "max": 255 }, "session_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "session_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "session_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
Enums
Namira Software Corporation
©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.