To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-content-template-api-v1
Returns the application health status
ns-content-template healthz get
Returns the value list of a given table and column
ns-content-template value list {table} {column}
Returns the content template category list
ns-content-template contenttemplatecategory list {filters} {page} {size}
Returns a content template category by id.
ns-content-template contenttemplatecategory get {id}
Creates a new content template category
ns-content-template contenttemplatecategory create
--entity_id (String)
--category_id (String)
Deletes a content template category by an id.
ns-content-template contenttemplatecategory delete {id}
Returns the content template field list
ns-content-template contenttemplatefield list {filters} {page} {size}
Returns a content template field by id.
ns-content-template contenttemplatefield get {id}
Creates a new content template field
ns-content-template contenttemplatefield create
--entity_id (String)
--field_id (String)
--value (String)
--description (String)
Updates a content template field by an id
ns-content-template contenttemplatefield update {id}
--entity_id (String)
--field_id (String)
--value (String)
--description (String)
Deletes a content template field by an id.
ns-content-template contenttemplatefield delete {id}
Returns the content template tag list
ns-content-template contenttemplatetag list {filters} {page} {size}
Returns a content template tag by id.
ns-content-template contenttemplatetag get {id}
Creates a new content template tag
ns-content-template contenttemplatetag create
--entity_id (String)
--name (String)
--value (String)
--description (String)
Updates a content template tag by an id
ns-content-template contenttemplatetag update {id}
--entity_id (String)
--name (String)
--value (String)
--description (String)
Deletes a content template tag by an id.
ns-content-template contenttemplatetag delete {id}
Returns the content template list
ns-content-template contenttemplate list {filters} {page} {size}
Returns a content template by an id
ns-content-template contenttemplate get {id}
Creates a new content template
ns-content-template contenttemplate create
--workspace_id (String)
--name (String)
--type (Enum)
--content (String)
--description (String)
--content_template_parameters (Array)
Updates a content template by an id
ns-content-template contenttemplate update {id}
--workspace_id (String)
--name (String)
--type (Enum)
--content (String)
--description (String)
--content_template_parameters (Array)
Deletes a content template by an id
ns-content-template contenttemplate delete {id}
Returns the content of the ContentTemplate
ns-content-template contenttemplate make {id}
--parameters (Object)
Sends an SMS with the content of the Content Template
ns-content-template contenttemplate sendsms {id} {provider_id}
--phone (String)
--parameters (Object)
Sends an Email with the content of the Content Template
ns-content-template contenttemplate sendemail {id} {provider_id}
--email (String)
--title (String)
--parameters (Object)
{  "name": "ContentTemplateCategory",  "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    }  }}
{  "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    }  }}
{  "name": "ContentTemplateField",  "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    }  }}
{  "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    }  }}
{  "name": "ContentTemplateTag",  "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    }  }}
{  "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    }  }}
{  "name": "ContentTemplate",  "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    },    "workspace_id": {      "type": "String",      "required": true,      "min": 20,      "max": 20,      "allowEmpty": false    },    "name": {      "type": "String",      "required": true,      "allowEmpty": false    },    "type": {      "name": "ContentTemplateType",      "type": "Enum",      "required": true,      "valids": [        "Plain",        "Json",        "Xml",        "Html",        "Yaml"      ]    },    "content": {      "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    }  }}
{  "name": "ContentTemplateInput",  "type": "Object",  "required": true,  "fields": {    "workspace_id": {      "type": "String",      "required": false,      "min": 20,      "max": 20,      "allowEmpty": false    },    "name": {      "type": "String",      "required": true,      "allowEmpty": false    },    "type": {      "name": "ContentTemplateType",      "type": "Enum",      "required": true,      "valids": [        "Plain",        "Json",        "Xml",        "Html",        "Yaml"      ]    },    "content": {      "type": "String",      "required": true,      "allowEmpty": false    },    "description": {      "type": "String",      "required": false,      "allowEmpty": true    },    "content_template_parameters": {      "type": "Array",      "required": false,      "items": [        {          "name": "ContentTemplateParameterInput",          "type": "Object",          "required": false,          "fields": {            "name": {              "type": "String",              "required": true,              "allowEmpty": false            },            "type": {              "name": "ContentTemplateParameterType",              "type": "Enum",              "required": true,              "valids": [                "Boolean",                "Integer",                "Float",                "String",                "Array",                "Object"              ]            },            "required": {              "type": "Boolean",              "required": true            },            "default": {              "type": "String",              "required": false,              "allowEmpty": true            }          }        }      ]    }  }}
{  "name": "ContentTemplateParameterInput",  "type": "Object",  "required": false,  "fields": {    "name": {      "type": "String",      "required": true,      "allowEmpty": false    },    "type": {      "name": "ContentTemplateParameterType",      "type": "Enum",      "required": true,      "valids": [        "Boolean",        "Integer",        "Float",        "String",        "Array",        "Object"      ]    },    "required": {      "type": "Boolean",      "required": true    },    "default": {      "type": "String",      "required": false,      "allowEmpty": true    }  }}
Plain
Json
Xml
Html
Yaml
Boolean
Integer
Float
String
Array
Object
©Copyright 2010 to 2024 Namira Software Corporation. All rights reserved.