Namirasoft Content Template API V1

Namira Software Corporation Content Template API Version 1 (1.4.25)

Install


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

npm i -g namirasoft-content-template-api-v1

Copied!

Commands


Healthz

Get

Returns the application health status

ns-content-template healthz get

Copied!

Value

List

Returns the value list of a given table and column

ns-content-template value list {table} {column} {search} {field_id} {limit}

Copied!

ContentTemplateCategory

List

Returns the content template category list

ns-content-template contenttemplatecategory list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a content template category by id.

ns-content-template contenttemplatecategory get {id}

Copied!

Create

Creates a new content template category for an entity

ns-content-template contenttemplatecategory create {entity_id}

Copied!

--category_id (String)

Delete

Deletes a content template category by an id.

ns-content-template contenttemplatecategory delete {entity_id} {id}

Copied!

ContentTemplateField

List

Returns the content template field list

ns-content-template contenttemplatefield list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a content template field by id.

ns-content-template contenttemplatefield get {id}

Copied!

Create

Creates a new content template field for an entity

ns-content-template contenttemplatefield create {entity_id}

Copied!

--field_id (String)

--value (String)

Update

Updates a content template field by an id for an entity

ns-content-template contenttemplatefield update {entity_id} {id}

Copied!

--field_id (String)

--value (String)

Delete

Deletes a content template field by an id.

ns-content-template contenttemplatefield delete {entity_id} {id}

Copied!

ContentTemplateTag

List

Returns the content template tag list

ns-content-template contenttemplatetag list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a content template tag by id.

ns-content-template contenttemplatetag get {id}

Copied!

Create

Creates a new content template tag for an entity

ns-content-template contenttemplatetag create {entity_id}

Copied!

--name (String)

--value (String)

Update

Updates a content template tag by an id for an entity

ns-content-template contenttemplatetag update {entity_id} {id}

Copied!

--name (String)

--value (String)

Delete

Deletes a content template tag by an id.

ns-content-template contenttemplatetag delete {entity_id} {id}

Copied!

ContentTemplate

List

Returns the content template list

ns-content-template contenttemplate list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a content template by an id

ns-content-template contenttemplate get {id}

Copied!

Create

Creates a new content template

ns-content-template contenttemplate create

Copied!

--workspace_id (String)

--name (String)

--type (Enum)

--content (String)

--parameters (Array)

--description (String)

--content_template_category (Array)

--content_template_field (Array)

--content_template_tag (Array)

Update

Updates a content template by an id

ns-content-template contenttemplate update {id}

Copied!

--workspace_id (String)

--name (String)

--type (Enum)

--content (String)

--parameters (Array)

--description (String)

--content_template_category (Array)

--content_template_field (Array)

--content_template_tag (Array)

Delete

Deletes a content template by an id

ns-content-template contenttemplate delete {id}

Copied!

Make

Returns the content of the ContentTemplate

ns-content-template contenttemplate make {id}

Copied!

--parameters (Object)

SendSMS

Sends an SMS with the content of the Content Template

ns-content-template contenttemplate sendsms {id} {provider_id}

Copied!

--phone (String)

--parameters (Object)

SendEmail

Sends an Email with the content of the Content Template

ns-content-template contenttemplate sendemail {id} {provider_id}

Copied!

--email (String)

--title (String)

--parameters (Object)

Schemas


ContentTemplateCategory

{
  "name": "ContentTemplateCategory",
  "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
    },
    "category_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityCategoryInput

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

ContentTemplateField

{
  "name": "ContentTemplateField",
  "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
    },
    "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
    }
  }
}

EntityFieldInput

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

ContentTemplateTag

{
  "name": "ContentTemplateTag",
  "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
    }
  }
}

EntityTagInput

{
  "name": "EntityTagInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "value": {
      "type": "String",
      "required": false
    }
  }
}

ContentTemplate

{
  "name": "ContentTemplate",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "workspace_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ContentTemplateType",
      "type": "Enum",
      "required": true,
      "valids": [
        "Plain",
        "Json",
        "Xml",
        "Html",
        "Yaml"
      ]
    },
    "content": {
      "type": "String",
      "required": true
    },
    "parameters": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "type": "Variable",
          "required": true
        }
      ]
    },
    "description": {
      "type": "String",
      "required": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

ContentTemplateFull

{
  "name": "ContentTemplateFull",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "workspace_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ContentTemplateType",
      "type": "Enum",
      "required": true,
      "valids": [
        "Plain",
        "Json",
        "Xml",
        "Html",
        "Yaml"
      ]
    },
    "content": {
      "type": "String",
      "required": true
    },
    "parameters": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "type": "Variable",
          "required": true
        }
      ]
    },
    "description": {
      "type": "String",
      "required": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    },
    "content_template_category": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityCategoryInput",
          "type": "Object",
          "required": false,
          "fields": {
            "category_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            }
          }
        }
      ]
    },
    "content_template_field": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityFieldInput",
          "type": "Object",
          "required": false,
          "fields": {
            "field_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            },
            "value": {
              "type": "String",
              "required": false
            }
          }
        }
      ]
    },
    "content_template_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
            }
          }
        }
      ]
    }
  }
}

ContentTemplateInput

{
  "name": "ContentTemplateInput",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ContentTemplateType",
      "type": "Enum",
      "required": true,
      "valids": [
        "Plain",
        "Json",
        "Xml",
        "Html",
        "Yaml"
      ]
    },
    "content": {
      "type": "String",
      "required": true
    },
    "parameters": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "type": "Variable",
          "required": true
        }
      ]
    },
    "description": {
      "type": "String",
      "required": false
    },
    "content_template_category": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityCategoryInput",
          "type": "Object",
          "required": false,
          "fields": {
            "category_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            }
          }
        }
      ]
    },
    "content_template_field": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityFieldInput",
          "type": "Object",
          "required": false,
          "fields": {
            "field_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            },
            "value": {
              "type": "String",
              "required": false
            }
          }
        }
      ]
    },
    "content_template_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

ContentTemplateType

Plain

Json

Xml

Html

Yaml

Namira Software Corporation

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