Namirasoft Email Sender API V1

Namira Software Corporation Email Sender API Version 1 (1.5.5)

Install


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

npm i -g namirasoft-email-sender-api-v1

Copied!

Commands


Health

Liveness

Returns the application liveness status

ns-email-sender health liveness

Copied!

Readiness

Returns the application readiness status

ns-email-sender health readiness

Copied!

Metrics

Get

Returns the application metrics

ns-email-sender metrics get

Copied!

Value

List

Returns the value list of a given table and column

ns-email-sender value list {table} {column} {search} {field_id} {limit}

Copied!

Overview

Count

Returns the row count of every entity across all databases, optionally grouped by workspace_id and filtered to specific workspaces

ns-email-sender overview count

Copied!

--group_by_workspace (Boolean)

--workspace_ids (Array)

ProviderCategory

List

Returns the provider category list

ns-email-sender providercategory list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a provider category by id.

ns-email-sender providercategory get {id}

Copied!

Create

Creates a new provider category for an entity

ns-email-sender providercategory create

Copied!

--slot_id (String)

--category_id (String)

Delete

Deletes a provider category by an id.

ns-email-sender providercategory delete {id}

Copied!

ProviderField

List

Returns the provider field list

ns-email-sender providerfield list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a provider field by id.

ns-email-sender providerfield get {id}

Copied!

Create

Creates a new provider field for an entity

ns-email-sender providerfield create

Copied!

--slot_id (String)

--field_id (String)

--value (Any)

Update

Updates a provider field by an id for an entity

ns-email-sender providerfield update {id}

Copied!

--slot_id (String)

--field_id (String)

--value (Any)

Delete

Deletes a provider field by an id.

ns-email-sender providerfield delete {id}

Copied!

ProviderTag

List

Returns the provider tag list

ns-email-sender providertag list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a provider tag by id.

ns-email-sender providertag get {id}

Copied!

Create

Creates a new provider tag for an entity

ns-email-sender providertag create

Copied!

--name (String)

--value (String)

Update

Updates a provider tag by an id for an entity

ns-email-sender providertag update {id}

Copied!

--name (String)

--value (String)

Delete

Deletes a provider tag by an id.

ns-email-sender providertag delete {id}

Copied!

Email

Send

Sends an Email

ns-email-sender email send

Copied!

--provider_id (String)

--email (String)

--title (String)

--message (String)

--html (Boolean)

_SendFor

Sends an Email for an user_id

ns-email-sender email _sendfor {user_id}

Copied!

--from_application (Boolean)

--provider_id (String)

--email (String)

--title (String)

--message (String)

--html (Boolean)

Provider

List

Returns the provider list

ns-email-sender provider list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a provider by an id

ns-email-sender provider get {id}

Copied!

Delete

Deletes a provider by an id

ns-email-sender provider delete {id}

Copied!

Request

Sends a provider validation request by Email

ns-email-sender provider request {id}

Copied!

--email (Email)

Verify

Verify provider

ns-email-sender provider verify {id}

Copied!

--code (String)

Namirasoft

Create

Creates a new namirasoft provider

ns-email-sender namirasoft create

Copied!

--workspace_id (String)

--name (String)

--limit (Boolean)

--limit_count (Integer)

--limit_per_value (Integer)

--limit_per_unit (Enum)

--delay (Boolean)

--delay_value (Integer)

--delay_unit (Enum)

--description (String)

--provider_category (Array)

--provider_field (Array)

--provider_tag (Array)

Update

Updates an namirasoft provider by an id

ns-email-sender namirasoft update {id}

Copied!

--workspace_id (String)

--name (String)

--limit (Boolean)

--limit_count (Integer)

--limit_per_value (Integer)

--limit_per_unit (Enum)

--delay (Boolean)

--delay_value (Integer)

--delay_unit (Enum)

--description (String)

--provider_category (Array)

--provider_field (Array)

--provider_tag (Array)

AWS

Create

Creates a new aws provider

ns-email-sender aws create

Copied!

--workspace_id (String)

--name (String)

--limit (Boolean)

--limit_count (Integer)

--limit_per_value (Integer)

--limit_per_unit (Enum)

--delay (Boolean)

--delay_value (Integer)

--delay_unit (Enum)

--description (String)

--region (String)

--access_key (String)

--secret_key (String)

--from (String)

--provider_category (Array)

--provider_field (Array)

--provider_tag (Array)

Update

Updates an aws provider by an id

ns-email-sender aws update {id}

Copied!

--workspace_id (String)

--name (String)

--limit (Boolean)

--limit_count (Integer)

--limit_per_value (Integer)

--limit_per_unit (Enum)

--delay (Boolean)

--delay_value (Integer)

--delay_unit (Enum)

--description (String)

--region (String)

--access_key (String)

--secret_key (String)

--from (String)

--reset_verified (Boolean)

--provider_category (Array)

--provider_field (Array)

--provider_tag (Array)

Gmail

Create

Creates a new gmail provider

ns-email-sender gmail create

Copied!

--workspace_id (String)

--name (String)

--limit (Boolean)

--limit_count (Integer)

--limit_per_value (Integer)

--limit_per_unit (Enum)

--delay (Boolean)

--delay_value (Integer)

--delay_unit (Enum)

--description (String)

--provider_category (Array)

--provider_field (Array)

--provider_tag (Array)

Update

Updates a gmail provider by an id

ns-email-sender gmail update {id}

Copied!

--workspace_id (String)

--name (String)

--limit (Boolean)

--limit_count (Integer)

--limit_per_value (Integer)

--limit_per_unit (Enum)

--delay (Boolean)

--delay_value (Integer)

--delay_unit (Enum)

--description (String)

--reset_verified (Boolean)

--provider_category (Array)

--provider_field (Array)

--provider_tag (Array)

SMTP

Create

Creates a new smtp provider

ns-email-sender smtp create

Copied!

--workspace_id (String)

--name (String)

--limit (Boolean)

--limit_count (Integer)

--limit_per_value (Integer)

--limit_per_unit (Enum)

--delay (Boolean)

--delay_value (Integer)

--delay_unit (Enum)

--description (String)

--host (String)

--port (Integer)

--username (String)

--password (String)

--provider_category (Array)

--provider_field (Array)

--provider_tag (Array)

Update

Updates a smtp provider by an id

ns-email-sender smtp update {id}

Copied!

--workspace_id (String)

--name (String)

--limit (Boolean)

--limit_count (Integer)

--limit_per_value (Integer)

--limit_per_unit (Enum)

--delay (Boolean)

--delay_value (Integer)

--delay_unit (Enum)

--description (String)

--host (String)

--port (Integer)

--username (String)

--password (String)

--reset_verified (Boolean)

--provider_category (Array)

--provider_field (Array)

--provider_tag (Array)

Sent

List

Returns the sent list

ns-email-sender sent list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a sent by an id

ns-email-sender sent get {id}

Copied!

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
        }
    }
}

ProviderCategory

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

EntityCategoryInput

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

ProviderField

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

EntityFieldInput

{
    "name": "EntityFieldInput",
    "type": "Object",
    "required": true,
    "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
        }
    }
}

ProviderTag

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

Provider

{
    "name": "Provider",
    "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": "ProviderType",
            "type": "Enum",
            "required": true,
            "valids": [
                "Namirasoft",
                "AWS",
                "SMTP",
                "Gmail"
            ]
        },
        "e_verified": {
            "type": "Boolean",
            "required": true
        },
        "meta": {
            "type": "Any",
            "required": false
        },
        "limit": {
            "type": "Boolean",
            "required": true
        },
        "limit_count": {
            "type": "Integer",
            "required": false
        },
        "limit_per_value": {
            "type": "Integer",
            "required": false
        },
        "limit_per_unit": {
            "name": "ProviderLimitPerUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Second",
                "Minute",
                "Hour",
                "Day"
            ]
        },
        "delay": {
            "type": "Boolean",
            "required": true
        },
        "delay_value": {
            "type": "Integer",
            "required": false
        },
        "delay_unit": {
            "name": "ProviderDelayUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Millisecond",
                "Second",
                "Minute"
            ]
        },
        "description": {
            "type": "String",
            "required": false
        },
        "created_at": {
            "type": "DateTime",
            "required": true
        },
        "updated_at": {
            "type": "DateTime",
            "required": true
        }
    }
}

NamirasoftCreate

{
    "name": "NamirasoftCreate",
    "type": "Object",
    "required": true,
    "fields": {
        "workspace_id": {
            "type": "String",
            "required": false,
            "min": 20,
            "max": 20
        },
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "limit": {
            "type": "Boolean",
            "required": true
        },
        "limit_count": {
            "type": "Integer",
            "required": false
        },
        "limit_per_value": {
            "type": "Integer",
            "required": false
        },
        "limit_per_unit": {
            "name": "ProviderLimitPerUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Second",
                "Minute",
                "Hour",
                "Day"
            ]
        },
        "delay": {
            "type": "Boolean",
            "required": true
        },
        "delay_value": {
            "type": "Integer",
            "required": false
        },
        "delay_unit": {
            "name": "ProviderDelayUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Millisecond",
                "Second",
                "Minute"
            ]
        },
        "description": {
            "type": "String",
            "required": false
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        }
    }
}

NamirasoftUpdate

{
    "name": "NamirasoftUpdate",
    "type": "Object",
    "required": true,
    "fields": {
        "workspace_id": {
            "type": "String",
            "required": false,
            "min": 20,
            "max": 20
        },
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "limit": {
            "type": "Boolean",
            "required": true
        },
        "limit_count": {
            "type": "Integer",
            "required": false
        },
        "limit_per_value": {
            "type": "Integer",
            "required": false
        },
        "limit_per_unit": {
            "name": "ProviderLimitPerUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Second",
                "Minute",
                "Hour",
                "Day"
            ]
        },
        "delay": {
            "type": "Boolean",
            "required": true
        },
        "delay_value": {
            "type": "Integer",
            "required": false
        },
        "delay_unit": {
            "name": "ProviderDelayUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Millisecond",
                "Second",
                "Minute"
            ]
        },
        "description": {
            "type": "String",
            "required": false
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        }
    }
}

AWSCreate

{
    "name": "AWSCreate",
    "type": "Object",
    "required": true,
    "fields": {
        "workspace_id": {
            "type": "String",
            "required": false,
            "min": 20,
            "max": 20
        },
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "limit": {
            "type": "Boolean",
            "required": true
        },
        "limit_count": {
            "type": "Integer",
            "required": false
        },
        "limit_per_value": {
            "type": "Integer",
            "required": false
        },
        "limit_per_unit": {
            "name": "ProviderLimitPerUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Second",
                "Minute",
                "Hour",
                "Day"
            ]
        },
        "delay": {
            "type": "Boolean",
            "required": true
        },
        "delay_value": {
            "type": "Integer",
            "required": false
        },
        "delay_unit": {
            "name": "ProviderDelayUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Millisecond",
                "Second",
                "Minute"
            ]
        },
        "description": {
            "type": "String",
            "required": false
        },
        "region": {
            "type": "String",
            "required": true
        },
        "access_key": {
            "type": "String",
            "required": true
        },
        "secret_key": {
            "type": "String",
            "required": true
        },
        "from": {
            "type": "String",
            "required": true
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        }
    }
}

AWSUpdate

{
    "name": "AWSUpdate",
    "type": "Object",
    "required": true,
    "fields": {
        "workspace_id": {
            "type": "String",
            "required": false,
            "min": 20,
            "max": 20
        },
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "limit": {
            "type": "Boolean",
            "required": true
        },
        "limit_count": {
            "type": "Integer",
            "required": false
        },
        "limit_per_value": {
            "type": "Integer",
            "required": false
        },
        "limit_per_unit": {
            "name": "ProviderLimitPerUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Second",
                "Minute",
                "Hour",
                "Day"
            ]
        },
        "delay": {
            "type": "Boolean",
            "required": true
        },
        "delay_value": {
            "type": "Integer",
            "required": false
        },
        "delay_unit": {
            "name": "ProviderDelayUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Millisecond",
                "Second",
                "Minute"
            ]
        },
        "description": {
            "type": "String",
            "required": false
        },
        "region": {
            "type": "String",
            "required": false
        },
        "access_key": {
            "type": "String",
            "required": false
        },
        "secret_key": {
            "type": "String",
            "required": false
        },
        "from": {
            "type": "String",
            "required": false
        },
        "reset_verified": {
            "type": "Boolean",
            "required": false
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        }
    }
}

GMailCreate

{
    "name": "GMailCreate",
    "type": "Object",
    "required": true,
    "fields": {
        "workspace_id": {
            "type": "String",
            "required": false,
            "min": 20,
            "max": 20
        },
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "limit": {
            "type": "Boolean",
            "required": true
        },
        "limit_count": {
            "type": "Integer",
            "required": false
        },
        "limit_per_value": {
            "type": "Integer",
            "required": false
        },
        "limit_per_unit": {
            "name": "ProviderLimitPerUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Second",
                "Minute",
                "Hour",
                "Day"
            ]
        },
        "delay": {
            "type": "Boolean",
            "required": true
        },
        "delay_value": {
            "type": "Integer",
            "required": false
        },
        "delay_unit": {
            "name": "ProviderDelayUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Millisecond",
                "Second",
                "Minute"
            ]
        },
        "description": {
            "type": "String",
            "required": false
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        }
    }
}

GMailUpdate

{
    "name": "GMailUpdate",
    "type": "Object",
    "required": true,
    "fields": {
        "workspace_id": {
            "type": "String",
            "required": false,
            "min": 20,
            "max": 20
        },
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "limit": {
            "type": "Boolean",
            "required": true
        },
        "limit_count": {
            "type": "Integer",
            "required": false
        },
        "limit_per_value": {
            "type": "Integer",
            "required": false
        },
        "limit_per_unit": {
            "name": "ProviderLimitPerUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Second",
                "Minute",
                "Hour",
                "Day"
            ]
        },
        "delay": {
            "type": "Boolean",
            "required": true
        },
        "delay_value": {
            "type": "Integer",
            "required": false
        },
        "delay_unit": {
            "name": "ProviderDelayUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Millisecond",
                "Second",
                "Minute"
            ]
        },
        "description": {
            "type": "String",
            "required": false
        },
        "reset_verified": {
            "type": "Boolean",
            "required": false
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        }
    }
}

SMTPCreate

{
    "name": "SMTPCreate",
    "type": "Object",
    "required": true,
    "fields": {
        "workspace_id": {
            "type": "String",
            "required": false,
            "min": 20,
            "max": 20
        },
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "limit": {
            "type": "Boolean",
            "required": true
        },
        "limit_count": {
            "type": "Integer",
            "required": false
        },
        "limit_per_value": {
            "type": "Integer",
            "required": false
        },
        "limit_per_unit": {
            "name": "ProviderLimitPerUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Second",
                "Minute",
                "Hour",
                "Day"
            ]
        },
        "delay": {
            "type": "Boolean",
            "required": true
        },
        "delay_value": {
            "type": "Integer",
            "required": false
        },
        "delay_unit": {
            "name": "ProviderDelayUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Millisecond",
                "Second",
                "Minute"
            ]
        },
        "description": {
            "type": "String",
            "required": false
        },
        "host": {
            "type": "String",
            "required": true
        },
        "port": {
            "type": "Integer",
            "required": true
        },
        "username": {
            "type": "String",
            "required": true
        },
        "password": {
            "type": "String",
            "required": true
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        }
    }
}

SMTPUpdate

{
    "name": "SMTPUpdate",
    "type": "Object",
    "required": true,
    "fields": {
        "workspace_id": {
            "type": "String",
            "required": false,
            "min": 20,
            "max": 20
        },
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "limit": {
            "type": "Boolean",
            "required": true
        },
        "limit_count": {
            "type": "Integer",
            "required": false
        },
        "limit_per_value": {
            "type": "Integer",
            "required": false
        },
        "limit_per_unit": {
            "name": "ProviderLimitPerUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Second",
                "Minute",
                "Hour",
                "Day"
            ]
        },
        "delay": {
            "type": "Boolean",
            "required": true
        },
        "delay_value": {
            "type": "Integer",
            "required": false
        },
        "delay_unit": {
            "name": "ProviderDelayUnit",
            "type": "Enum",
            "required": false,
            "valids": [
                "Millisecond",
                "Second",
                "Minute"
            ]
        },
        "description": {
            "type": "String",
            "required": false
        },
        "host": {
            "type": "String",
            "required": false
        },
        "port": {
            "type": "Integer",
            "required": false
        },
        "username": {
            "type": "String",
            "required": false
        },
        "password": {
            "type": "String",
            "required": false
        },
        "reset_verified": {
            "type": "Boolean",
            "required": false
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        },
        "provider_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
                        }
                    }
                }
            ]
        }
    }
}

Sent

{
    "name": "Sent",
    "type": "Object",
    "required": true,
    "fields": {
        "id": {
            "type": "String",
            "required": true
        },
        "user_id": {
            "type": "String",
            "required": true
        },
        "session_id": {
            "type": "String",
            "required": true
        },
        "workspace_id": {
            "type": "String",
            "required": false
        },
        "provider_id": {
            "type": "String",
            "required": true
        },
        "email": {
            "type": "String",
            "required": true
        },
        "title": {
            "type": "String",
            "required": true
        },
        "message": {
            "type": "String",
            "required": true
        },
        "html": {
            "type": "Boolean",
            "required": true
        },
        "created_at": {
            "type": "DateTime",
            "required": true
        },
        "sent_at": {
            "type": "DateTime",
            "required": false
        },
        "successful": {
            "type": "Boolean",
            "required": false
        },
        "result": {
            "type": "String",
            "required": false
        }
    }
}

Enums

ProviderType

Namirasoft

AWS

SMTP

Gmail

ProviderLimitPerUnit

Second

Minute

Hour

Day

ProviderDelayUnit

Millisecond

Second

Minute

Namira Software Corporation

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