onfleet.json•8.6 kB
{
"nodeType": "n8n-nodes-base.onfleet",
"displayName": "Onfleet",
"description": "Consume Onfleet API",
"version": 1,
"properties": [
{
"name": "id",
"displayName": "Admin ID",
"type": "string",
"default": "",
"description": "The ID of the admin object for lookup",
"required": true,
"displayOptions": {
"show": {
"resource": [
"admin"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"displayOptions": {
"show": {
"resource": [
"admin"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 64,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1,
"maxValue": 64
},
"displayOptions": {
"show": {
"resource": [
"admin"
],
"operation": [
"getAll"
],
"returnAll": [
false
]
}
}
},
{
"name": "additionalFields",
"displayName": "Additional Fields",
"type": "collection",
"default": {},
"placeholder": "Add Field",
"displayOptions": {
"show": {
"resource": [
"admin"
],
"operation": [
"create"
]
}
}
},
{
"name": "updateFields",
"displayName": "Update Fields",
"type": "collection",
"default": {},
"placeholder": "Add Field",
"displayOptions": {
"show": {
"resource": [
"admin"
],
"operation": [
"update"
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "getAll",
"description": "Create a new Onfleet admin",
"options": [
{
"name": "Create",
"value": "create",
"description": "Create a new Onfleet admin"
},
{
"name": "Delete",
"value": "delete",
"description": "Delete an Onfleet admin"
},
{
"name": "Get Many",
"value": "getAll",
"description": "Get many Onfleet admins"
},
{
"name": "Update",
"value": "update",
"description": "Update an Onfleet admin"
}
],
"displayOptions": {
"show": {
"resource": [
"admin"
]
}
}
},
{
"name": "options",
"displayName": "Options",
"type": "collection",
"default": {},
"placeholder": "Add option",
"required": false,
"options": [
{}
],
"displayOptions": {
"show": {
"resource": [
"container"
],
"operation": [
"addTask",
"updateTask"
]
}
}
},
{
"name": "getBy",
"displayName": "Get By",
"type": "options",
"default": "id",
"description": "The variable that is used for looking up a recipient",
"required": true,
"options": [
{
"name": "ID",
"value": "id"
},
{
"name": "Phone",
"value": "phone"
},
{
"name": "Name",
"value": "name"
}
],
"displayOptions": {
"show": {
"resource": [
"recipient"
],
"operation": [
"get"
]
}
}
},
{
"name": "name",
"displayName": "Name",
"type": "string",
"default": "",
"description": "The name of the recipient for lookup",
"required": true,
"displayOptions": {
"show": {
"resource": [
"recipient"
],
"operation": [
"get"
],
"getBy": [
"name"
]
}
}
},
{
"name": "phone",
"displayName": "Phone",
"type": "string",
"default": "",
"description": "The phone of the recipient for lookup",
"required": true,
"displayOptions": {
"show": {
"resource": [
"recipient"
],
"operation": [
"get"
],
"getBy": [
"phone"
]
}
}
},
{
"name": "success",
"displayName": "Complete as a Success",
"type": "boolean",
"default": true,
"description": "Whether the task's completion was successful",
"required": true,
"displayOptions": {
"show": {
"resource": [
"task"
],
"operation": [
"complete"
]
}
}
},
{
"name": "filters",
"displayName": "Filters",
"type": "collection",
"default": {},
"description": "The starting time of the range. Tasks created or completed at or after this time will be included.",
"placeholder": "Add Filter",
"options": [
{
"name": "from",
"displayName": "From",
"type": "dateTime",
"default": "",
"description": "The starting time of the range. Tasks created or completed at or after this time will be included."
}
],
"displayOptions": {
"show": {
"resource": [
"task"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "overrideFields",
"displayName": "Override Fields",
"type": "collection",
"default": {},
"placeholder": "Add Field",
"required": false,
"options": [
{},
{},
{
"name": "includeBarcodes",
"displayName": "Include Barcodes",
"type": "boolean",
"default": false
},
{
"name": "includeDependencies",
"displayName": "Include Dependencies",
"type": "boolean",
"default": false
},
{
"name": "includeMetadata",
"displayName": "Include Metadata",
"type": "boolean",
"default": false
},
{},
{},
{}
],
"displayOptions": {
"show": {
"resource": [
"task"
],
"operation": [
"clone"
]
}
}
},
{
"name": "schedule",
"displayName": "Schedule",
"type": "fixedCollection",
"default": {},
"placeholder": "Add Schedule",
"required": true,
"typeOptions": {
"multipleValues": true
},
"displayOptions": {
"show": {
"resource": [
"worker"
],
"operation": [
"setSchedule"
]
}
}
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "task",
"description": "The resource to perform operations on",
"options": [
{
"name": "Admin",
"value": "admin"
},
{
"name": "Container",
"value": "container"
},
{
"name": "Destination",
"value": "destination"
},
{
"name": "Hub",
"value": "hub"
},
{
"name": "Organization",
"value": "organization"
},
{
"name": "Recipient",
"value": "recipient"
},
{
"name": "Task",
"value": "task"
},
{
"name": "Team",
"value": "team"
},
{
"name": "Worker",
"value": "worker"
}
]
}
],
"credentialsConfig": [
{
"name": "onfleetApi",
"required": true
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [],
"outputs": [],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [],
"produces": []
}
}