Namirasoft API Product V1
Namira Software Corporation API Product Version 1 (1.4.33)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-api-product-v1
Copied!
Commands
Healthz
Get
Returns the application health status
ns-api-product healthz get
Copied!
Filter
List
Returns the filter list
ns-api-product filter list {filters} {page} {size} {sorts}
Copied!
ListProducts
Returns the product list by scope and name
ns-api-product filter listproducts {scope} {name} {filters} {page} {size} {sorts}
Copied!
Get
Returns a filter by an id
ns-api-product filter get {id}
Copied!
Product
List
Returns the product list
ns-api-product product list {filters} {page} {size} {sorts}
Copied!
Get
Returns a product by an id
ns-api-product product get {id}
Copied!
Set
Sets all the required product of a product
ns-api-product product set {product_id}
Copied!
<@row_option>
@row_option_text
<@row_option@>GetMeta
Returns a meta product by an id
ns-api-product product getmeta {id}
Copied!
Category
List
Returns the category list
ns-api-product category list {filters} {page} {size} {sorts}
Copied!
Get
Returns a category by an id
ns-api-product category get {id}
Copied!
Owner
List
Returns the owner list
ns-api-product owner list {filters} {page} {size} {sorts}
Copied!
Get
Returns an owner by an id
ns-api-product owner get {id}
Copied!
Store
List
Returns the store list
ns-api-product store list {filters} {page} {size} {sorts}
Copied!
Get
Returns a store by an id
ns-api-product store get {id}
Copied!
Instance
Get
Returns an instance by product id and code
ns-api-product instance get {product_id} {code}
Copied!
Schemas
Filter
{ "name": "Filter", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "scope": { "type": "String", "required": true, "max": 255 }, "name": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
ProductFull
{ "name": "ProductFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "owner_id": { "type": "Integer", "required": true }, "category_id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "slug": { "type": "String", "required": true, "max": 255 }, "headline": { "type": "String", "required": true, "max": 255 }, "application": { "type": "Boolean", "required": true }, "platform": { "type": "Boolean", "required": true }, "description": { "type": "String", "required": false }, "logo": { "type": "String", "required": false, "max": 255 }, "background": { "type": "String", "required": false, "max": 255 }, "link": { "type": "String", "required": false, "max": 255 }, "terms": { "type": "String", "required": false, "max": 255 }, "terms_version": { "type": "String", "required": false, "max": 255 }, "privacy": { "type": "String", "required": false, "max": 255 }, "privacy_version": { "type": "String", "required": false, "max": 255 }, "minimum_version": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "owner": { "name": "Owner", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "logo": { "type": "String", "required": false, "max": 255 }, "link": { "type": "String", "required": false, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } }, "category": { "name": "Category", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } }, "product_store": { "type": "Array", "required": true, "items": [ { "name": "ProductStoreFull", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "store_id": { "type": "Integer", "required": true }, "link": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "store": { "name": "Store", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "logo": { "type": "String", "required": false, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } } } ] } }}
Owner
{ "name": "Owner", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "logo": { "type": "String", "required": false, "max": 255 }, "link": { "type": "String", "required": false, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Category
{ "name": "Category", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
ProductStoreFull
{ "name": "ProductStoreFull", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "store_id": { "type": "Integer", "required": true }, "link": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "store": { "name": "Store", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "logo": { "type": "String", "required": false, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } }}
Store
{ "name": "Store", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "name": { "type": "String", "required": true, "max": 255 }, "logo": { "type": "String", "required": false, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
InstanceFull
{ "name": "InstanceFull", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "code": { "type": "String", "required": true, "max": 255 }, "public": { "type": "Boolean", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "instance_user": { "type": "Array", "required": true, "items": [ { "name": "InstanceUser", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "instance_id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } ] } }}
InstanceUser
{ "name": "InstanceUser", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "instance_id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Enums
Namira Software Corporation
©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.