backendless-console-sdk
Version:
Backendless Console SDK for Node.js and browser
1,475 lines • 125 kB
JSON
[
{
"methods": [
{
"params": [
{
"type": "string",
"name": "zone",
"label": "Zone",
"description": "The deployment zone. Valid values: 'US' or 'EU'",
"optional": true
}
],
"methodName": "getApps",
"description": "Retrieves a list of applications for the specified zone.",
"methodLabel": "Get Applications",
"category": "Apps Management",
"sampleResult": "[{\"version\":\"6.0.0\",\"created\":1700000000000,\"subscriptionId\":null,\"originDomains\":\"*\",\"customDomains\":[],\"showKitApiKey\":null,\"dbVersion\":165,\"lastDayOfUse\":1700000001000,\"ownerDeveloperId\":\"DEV-ID-123\",\"zoneId\":1,\"oldGeoServiceEnabled\":false,\"type\":\"general\",\"metaInfo\":{\"source\":null,\"enabledPanicModes\":[],\"compliance\":{\"hipaa\":null},\"mongoDbVersion\":10,\"useOldTableRelationsFormat\":false},\"id\":\"APP-ID-123\",\"name\":\"MyApp\"},{\"version\":\"6.0.0\",\"created\":1700000002000,\"subscriptionId\":\"SUB-456\",\"originDomains\":\"*\",\"customDomains\":[],\"showKitApiKey\":null,\"dbVersion\":165,\"lastDayOfUse\":1700000003000,\"ownerDeveloperId\":\"DEV-ID-123\",\"zoneId\":1,\"oldGeoServiceEnabled\":false,\"type\":\"general\",\"metaInfo\":{\"source\":null,\"enabledPanicModes\":[],\"compliance\":{\"hipaa\":null},\"mongoDbVersion\":10,\"useOldTableRelationsFormat\":false},\"id\":\"APP-ID-456\",\"name\":\"TestApp\"}]"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application to rename",
"optional": true
},
{
"type": "string",
"name": "appName",
"label": "New App Name",
"description": "The new name for the application",
"optional": true
}
],
"methodName": "renameApp",
"description": "Changes the name of an existing application.",
"methodLabel": "Rename Application",
"category": "Apps Management",
"sampleResult": "{\"appName\":\"RenamedApp\",\"appId\":\"APP-ID-123\",\"version\":\"6.0.0\",\"created\":1700000000000,\"subscriptionId\":\"SUB-456\",\"originDomains\":\"*\",\"customDomains\":[],\"showKitApiKey\":null,\"dbVersion\":165,\"lastDayOfUse\":1700000001000,\"ownerDeveloperId\":\"DEV-ID-123\",\"zoneId\":1,\"oldGeoServiceEnabled\":false,\"type\":\"general\",\"metaInfo\":{\"source\":null,\"enabledPanicModes\":[],\"compliance\":{\"hipaa\":null},\"mongoDbVersion\":10,\"useOldTableRelationsFormat\":false}}"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application to delete",
"optional": true
}
],
"methodName": "deleteApp",
"description": "Permanently deletes an application and all its data.",
"methodLabel": "Delete Application",
"category": "Apps Management",
"sampleResult": "{\"success\":true}"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application to archive",
"optional": true
}
],
"methodName": "generateAppZIP",
"description": "Generates a ZIP archive of the application for backup or transfer.",
"methodLabel": "Generate App ZIP",
"category": "Apps Management",
"sampleResult": "\"Application transfer started. At the end, you will receive an email with the link to download zip file.\""
},
{
"params": [
{
"type": "array",
"name": "appsIds",
"label": "App IDs",
"description": "List of application identifiers",
"optional": true
}
],
"methodName": "loadAppsInfo",
"description": "Retrieves detailed information for multiple applications.",
"methodLabel": "Load Apps Info",
"category": "Apps Management",
"sampleResult": "[{\"id\":\"APP-ID-123\",\"name\":\"MyApp\",\"version\":\"6.0.0\",\"created\":1700000000000},{\"id\":\"APP-ID-456\",\"name\":\"TestApp\",\"version\":\"6.0.0\",\"created\":1700000001000}]"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "updateAppInfo__info",
"name": "info",
"label": "App Information",
"description": "Object containing updated application information",
"optional": true
}
],
"methodName": "updateAppInfo",
"description": "Updates the information and metadata of an application.",
"methodLabel": "Update App Info",
"category": "Apps Management",
"sampleResult": "{\"appId\":\"APP-ID-123\",\"devEmail\":\"developer@example.com\",\"appName\":\"UpdatedAppName\"}"
}
],
"serviceInfo": {
"fileName": "../src/apps.js",
"serviceName": "apps"
}
},
{
"methods": [],
"serviceInfo": {
"fileName": "../src/automation.js",
"serviceName": "serviceName"
}
},
{
"methods": [
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "object",
"name": "params",
"label": "Pagination Parameters",
"description": "Optional parameters for pagination",
"properties": [
{
"name": "pageSize",
"label": "Page Size",
"type": "number",
"optional": true,
"description": "Number of cache entries to return per page"
},
{
"name": "offset",
"label": "Offset",
"type": "number",
"optional": true,
"description": "Number of cache entries to skip for pagination"
}
],
"expandedFromTypedef": "getCacheData__params",
"optional": true
}
],
"methodName": "get",
"description": "Retrieves cache entries with pagination support and returns both data and total count.",
"methodLabel": "Get Cache Data",
"category": "Data",
"sampleResult": "{\"data\":[{\"objectId\":\"user:123\",\"value\":\"John Doe\",\"expireAt\":1700000000000,\"key\":\"user:123\"}],\"totalRows\":25}"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
}
],
"methodName": "count",
"description": "Returns the total number of cache entries in the application.",
"methodLabel": "Count Cache Entries",
"category": "Data",
"sampleResult": "42"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "object",
"name": "record",
"label": "Cache Record",
"description": "The cache entry data",
"properties": [
{
"name": "key",
"label": "Key",
"type": "string",
"optional": true,
"description": "The cache key (either key or objectId is required)"
},
{
"name": "objectId",
"label": "Object ID",
"type": "string",
"optional": true,
"description": "Alternative identifier for the cache entry"
},
{
"name": "value",
"label": "Value",
"type": "any",
"optional": true,
"description": "The value to be cached (can be any type, will be JSON stringified)"
},
{
"name": "expireAt",
"label": "Expire At",
"type": "string",
"optional": true,
"description": "ISO date string when the cache entry should expire"
}
],
"expandedFromTypedef": "updateCacheEntry__record",
"optional": true
}
],
"methodName": "update",
"description": "Updates or creates a cache entry with the specified key, value, and expiration time.",
"methodLabel": "Update Cache Entry",
"category": "Data",
"sampleResult": "\"\""
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "key",
"label": "Cache Key",
"description": "The key of the cache entry to be removed",
"optional": true
}
],
"methodName": "remove",
"description": "Permanently removes a cache entry by its key.",
"methodLabel": "Remove Cache Entry",
"category": "Data",
"sampleResult": "\"\""
}
],
"serviceInfo": {
"fileName": "../src/cache.js",
"serviceName": "cache"
}
},
{
"methods": [
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "object",
"name": "params",
"label": "Query Parameters",
"description": "Optional pagination, sorting, and filtering parameters",
"properties": [
{
"name": "pageSize",
"label": "Page Size",
"type": "number",
"optional": true,
"description": "Number of counters to return per page"
},
{
"name": "offset",
"label": "Offset",
"type": "number",
"optional": true,
"description": "Number of counters to skip for pagination"
},
{
"name": "sortField",
"label": "Sort Field",
"type": "string",
"optional": true,
"description": "Field name to sort counters by"
},
{
"name": "sortDir",
"label": "Sort Direction",
"type": "string",
"optional": true,
"description": "Direction of sorting, either ASC or DESC"
},
{
"name": "pattern",
"label": "Pattern",
"type": "string",
"optional": true,
"description": "Filter counters by name pattern (wildcards supported)"
}
],
"expandedFromTypedef": "getAtomicCounters__params",
"optional": true
}
],
"methodName": "get",
"description": "Retrieves a list of atomic counters with pagination and sorting support.",
"methodLabel": "Get Atomic Counters",
"category": "Counters",
"sampleResult": "{\"data\":[{\"objectId\":\"counterA\",\"name\":\"counterA\",\"value\":10},{\"objectId\":\"counterB\",\"name\":\"counterB\",\"value\":25}],\"totalRows\":2}"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "pattern",
"label": "Pattern",
"description": "Filter counters by name pattern (wildcards supported)",
"optional": true
}
],
"methodName": "listNames",
"description": "Retrieves a list of all atomic counter names matching a specified pattern.",
"methodLabel": "List Atomic Counter Names",
"category": "Counters"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "array",
"name": "names",
"label": "Counter Names",
"description": "Array of atomic counter names to retrieve",
"optional": true
}
],
"methodName": "listCounters",
"description": "Retrieves atomic counters by a list of specific names.",
"methodLabel": "List Atomic Counters by Names",
"category": "Counters"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "name",
"label": "Counter Name",
"description": "The name of the atomic counter",
"optional": true
},
{
"type": "number",
"name": "value",
"label": "Initial Value",
"description": "Initial value for the counter",
"optional": true
}
],
"methodName": "create",
"description": "Creates a new atomic counter with the specified initial value.",
"methodLabel": "Create Atomic Counter",
"category": "Counters",
"sampleResult": "{\"name\":\"counterA\",\"value\":10}"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "name",
"label": "Counter Name",
"description": "The name of the atomic counter to update",
"optional": true
},
{
"type": "number",
"name": "currentValue",
"label": "Current Value",
"description": "The expected current value of the counter (used for optimistic concurrency)",
"optional": true
},
{
"type": "number",
"name": "newValue",
"label": "New Value",
"description": "The new value to set for the counter",
"optional": true
}
],
"methodName": "update",
"description": "Updates the value of an atomic counter.",
"methodLabel": "Update Atomic Counter",
"category": "Counters",
"sampleResult": "\"\""
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "name",
"label": "Counter Name",
"description": "The name of the atomic counter to be removed",
"optional": true
}
],
"methodName": "remove",
"description": "Permanently removes an atomic counter by its name.",
"methodLabel": "Remove Atomic Counter",
"category": "Counters",
"sampleResult": "\"\""
}
],
"serviceInfo": {
"fileName": "../src/counters.js",
"serviceName": "counters"
}
},
{
"methods": [
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
}
],
"methodName": "getHiveNames",
"description": "Retrieves all hive names for an application.",
"methodLabel": "Get Hive Names",
"category": "Data Hives",
"sampleResult": "[\"hive1\",\"hive2\",\"testHive\"]"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "hiveName",
"label": "Hive Name",
"description": "The name of the hive to create",
"optional": true
}
],
"methodName": "createHive",
"description": "Creates a new data hive in an application.",
"methodLabel": "Create Hive",
"category": "Data Hives",
"sampleResult": "\"\""
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "oldName",
"label": "Old Name",
"description": "The current name of the hive",
"optional": true
},
{
"type": "string",
"name": "newName",
"label": "New Name",
"description": "The new name for the hive",
"optional": true
}
],
"methodName": "renameHive",
"description": "Renames an existing data hive.",
"methodLabel": "Rename Hive",
"category": "Data Hives",
"sampleResult": "{\"success\":true}"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "hiveName",
"label": "Hive Name",
"description": "The name of the hive to delete",
"optional": true
}
],
"methodName": "deleteHive",
"description": "Deletes a data hive and all its data.",
"methodLabel": "Delete Hive",
"category": "Data Hives",
"sampleResult": "{\"success\":true}"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "hiveName",
"label": "Hive Name",
"description": "The name of the hive",
"optional": true
},
{
"type": "string",
"name": "storeType",
"label": "Store Type",
"description": "The type of store. Valid values: 'key-value', 'list', 'map', 'set', 'sorted-set'",
"optional": true
},
{
"type": "string",
"name": "keyName",
"label": "Key Name",
"description": "The key name",
"optional": true
},
{
"type": "HiveStorePayload",
"name": "payload",
"label": "Payload",
"description": "Object with 'value' field containing data to store",
"optional": true
}
],
"methodName": "setHiveStoreValue",
"description": "Sets a value in the hive store for any store type (key-value, list, map, set, sorted-set). Value must be wrapped in object with 'value' field.",
"methodLabel": "Set Hive Store Value",
"category": "Data Hives",
"sampleResult": "true"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "hiveName",
"label": "Hive Name",
"description": "The name of the hive",
"optional": true
},
{
"type": "string",
"name": "storeType",
"label": "Store Type",
"description": "The type of store. Valid values: 'key-value', 'list', 'map', 'set', 'sorted-set'",
"optional": true
},
{
"type": "string",
"name": "keyName",
"label": "Key Name",
"description": "The key name",
"optional": true
},
{
"type": "HiveStorePayload",
"name": "payload",
"label": "Payload",
"description": "Object with 'value' field containing data to store",
"optional": true
}
],
"methodName": "addHiveStoreValue",
"description": "Adds/creates a value in the hive store for any store type (key-value, list, map, set, sorted-set). Value must be wrapped in object with 'value' field.",
"methodLabel": "Add Hive Store Value",
"category": "Data Hives",
"sampleResult": "true"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "hiveName",
"label": "Hive Name",
"description": "The name of the hive",
"optional": true
},
{
"type": "string",
"name": "storeType",
"label": "Store Type",
"description": "The type of store. Valid values: 'key-value', 'list', 'map', 'set', 'sorted-set'",
"optional": true
},
{
"type": "array",
"name": "keys",
"label": "Keys",
"description": "Array of key names to remove",
"optional": true
}
],
"methodName": "removeHiveStoreRecords",
"description": "Removes multiple records from a hive store by their keys. Works with any store type (key-value, list, map, set, sorted-set).",
"methodLabel": "Remove Hive Store Records",
"category": "Data Hives",
"sampleResult": "1"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "hiveName",
"label": "Hive Name",
"description": "The name of the hive",
"optional": true
},
{
"type": "string",
"name": "storeType",
"label": "Store Type",
"description": "The type of store. Valid values: 'key-value', 'list', 'map', 'set', 'sorted-set'",
"optional": true
},
{
"type": "string",
"name": "keyName",
"label": "Key Name",
"description": "The key name",
"optional": true
},
{
"type": "array",
"name": "values",
"label": "Values",
"description": "Array of values to remove from the key",
"optional": true
}
],
"methodName": "removeHiveStoreValue",
"description": "Removes specific values from a hive store key. Works with any store type (key-value, list, map, set, sorted-set).",
"methodLabel": "Remove Hive Store Value",
"category": "Data Hives",
"sampleResult": "1"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "hiveName",
"label": "Hive Name",
"description": "The name of the hive",
"optional": true
},
{
"type": "string",
"name": "storeType",
"label": "Store Type",
"description": "The type of store. Valid values: 'key-value', 'list', 'map', 'set', 'sorted-set'",
"optional": true
},
{
"type": "string",
"name": "key",
"label": "Key",
"description": "The key name",
"optional": true
},
{
"type": "SetKeyExpiration__options",
"name": "options",
"label": "Expiration Options",
"description": "Object with either ttl (seconds from now) or unixTime (Unix timestamp in seconds)",
"optional": true
}
],
"methodName": "setKeyExpiration",
"description": "Sets expiration time for a hive key of any store type (key-value, list, map, set, sorted-set). Use either TTL (seconds from now) or Unix timestamp (in seconds).",
"methodLabel": "Set Key Expiration",
"category": "Data Hives",
"sampleResult": "\"\""
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "hiveName",
"label": "Hive Name",
"description": "The name of the hive",
"optional": true
},
{
"type": "string",
"name": "storeType",
"label": "Store Type",
"description": "The type of store. Valid values: 'key-value', 'list', 'map', 'set', 'sorted-set'",
"optional": true
},
{
"type": "string",
"name": "key",
"label": "Key",
"description": "The key name",
"optional": true
}
],
"methodName": "getKeyExpirationTTL",
"description": "Gets the time-to-live for a hive key of any store type (key-value, list, map, set, sorted-set).",
"methodLabel": "Get Key Expiration TTL",
"category": "Data Hives",
"sampleResult": "34"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "hiveName",
"label": "Hive Name",
"description": "The name of the hive",
"optional": true
},
{
"type": "string",
"name": "storeType",
"label": "Store Type",
"description": "The type of store. Valid values: 'key-value', 'list', 'map', 'set', 'sorted-set'",
"optional": true
},
{
"type": "string",
"name": "key",
"label": "Key",
"description": "The key name",
"optional": true
}
],
"methodName": "clearKeyExpiration",
"description": "Removes expiration from a hive key of any store type (key-value, list, map, set, sorted-set).",
"methodLabel": "Clear Key Expiration",
"category": "Data Hives",
"sampleResult": "true"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "hiveName",
"label": "Hive Name",
"description": "The name of the hive",
"optional": true
},
{
"type": "string",
"name": "storeType",
"label": "Store Type",
"description": "The type of store. Valid values: 'key-value', 'list', 'map', 'set', 'sorted-set'",
"optional": true
},
{
"type": "string",
"name": "key",
"label": "Key",
"description": "The key name",
"optional": true
}
],
"methodName": "getKeySecondsSinceLastOperation",
"description": "Gets seconds elapsed since the last operation on a key of any store type (key-value, list, map, set, sorted-set).",
"methodLabel": "Get Key Seconds Since Last Operation",
"category": "Data Hives",
"sampleResult": "4"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "hiveName",
"label": "Hive Name",
"description": "The name of the hive",
"optional": true
},
{
"type": "string",
"name": "key",
"label": "Key",
"description": "The key name",
"optional": true
},
{
"type": "array",
"name": "items",
"label": "Items",
"description": "Array of items to add to the list",
"optional": true
}
],
"methodName": "addHiveListStoreItems",
"description": "[LIST STORE TYPE] Adds items to the end of a list store. Lists maintain insertion order and allow duplicates. Creates the list if it doesn't exist.",
"methodLabel": "Add List Store Items",
"category": "Data Hives",
"sampleResult": "6"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "hiveName",
"label": "Hive Name",
"description": "The name of the hive",
"optional": true
},
{
"type": "string",
"name": "key",
"label": "Key",
"description": "The key name",
"optional": true
},
{
"type": "string",
"name": "value",
"label": "Value",
"description": "The value to remove",
"optional": true
}
],
"methodName": "removeHiveListStoreItemByValue",
"description": "[LIST STORE TYPE] Removes items with specified value from a list store. Lists maintain insertion order and allow duplicates.",
"methodLabel": "Remove List Item by Value",
"category": "Data Hives",
"sampleResult": "1"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "hiveName",
"label": "Hive Name",
"description": "The name of the hive",
"optional": true
},
{
"type": "string",
"name": "key",
"label": "Key",
"description": "The key name",
"optional": true
},
{
"type": "number",
"name": "index",
"label": "Index",
"description": "The index position",
"optional": true
},
{
"type": "string",
"name": "value",
"label": "Value",
"description": "The new value",
"optional": true
}
],
"methodName": "updateHiveListStoreItemByIndex",
"description": "[LIST STORE TYPE] Updates a list item at specified index. Lists are zero-indexed and maintain insertion order.",
"methodLabel": "Update List Item by Index",
"category": "Data Hives",
"sampleResult": "\"\""
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "hiveName",
"label": "Hive Name",
"description": "The name of the hive",
"optional": true
},
{
"type": "string",
"name": "key",
"label": "Key",
"description": "The key name",
"optional": true
},
{
"type": "array",
"name": "items",
"label": "Items",
"description": "Array of items to add to the set (duplicates will be filtered out)",
"optional": true
}
],
"methodName": "addHiveSetStoreItems",
"description": "[SET STORE TYPE] Adds items to a set store. Sets automatically handle duplicates - only unique values are stored. Creates the set if it doesn't exist.",
"methodLabel": "Add Set Store Items",
"category": "Data Hives",
"sampleResult": "3"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "hiveName",
"label": "Hive Name",
"description": "The name of the hive",
"optional": true
},
{
"type": "string",
"name": "key",
"label": "Key",
"description": "The key name",
"optional": true
},
{
"type": "string",
"name": "value",
"label": "Value",
"description": "The value to remove",
"optional": true
}
],
"methodName": "removeHiveSetStoreItemByValue",
"description": "[SET STORE TYPE] Removes specified value from a set store. Sets contain only unique values.",
"methodLabel": "Remove Set Item by Value",
"category": "Data Hives",
"sampleResult": "1"
}
],
"serviceInfo": {
"fileName": "../src/data-hives.js",
"serviceName": "dataHives"
}
},
{
"methods": [
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
}
],
"methodName": "getDevelopers",
"description": "Retrieve list of developers for an application",
"methodLabel": "Get Developers",
"category": "Development Team",
"sampleResult": "[{\"id\":\"D7ED38DB-2CD5-4E2D-BBCE-131F7D40254C\",\"name\":\"Sergey Androsov\",\"email\":\"androsov.srg@gmail.com\"}]"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "object",
"name": "email",
"label": "Email Object",
"description": "Object containing the email address of the developer to invite",
"properties": [
{
"name": "email",
"label": "Email Address",
"type": "string",
"optional": true,
"description": "The email address of the developer to invite to the team"
}
],
"expandedFromTypedef": "inviteDeveloper__email",
"optional": true
}
],
"methodName": "inviteDeveloper",
"description": "Send an invitation to a developer to join the application team",
"methodLabel": "Invite Developer",
"category": "Development Team",
"sampleResult": "{\"id\":\"ABC123-DEF456-GHI789\",\"name\":\"Invited\",\"email\":\"developer@example.com\",\"lastLogin\":null,\"registrationDate\":1672531200000,\"system\":false,\"permissionGroups\":[{\"groupName\":\"Data Service\",\"permissions\":[{\"id\":\"40\",\"operation\":\"Create/Rename/Delete tables\",\"access\":\"DENY\",\"visible\":true}],\"visible\":true}],\"notifications\":[{\"type\":\"PERCENT_80\",\"group\":\"Limits\",\"enabled\":false}]}"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "devId",
"label": "Developer ID",
"description": "The identifier of the developer to remove",
"optional": true
}
],
"methodName": "removeDeveloper",
"description": "Remove a developer from the application team",
"methodLabel": "Remove Developer",
"category": "Development Team",
"sampleResult": "\"\""
},
{
"params": [],
"methodName": "generateDeveloperSignature",
"description": "Generate a signature for the current developer",
"methodLabel": "Generate Developer Signature",
"category": "Development Team",
"sampleResult": "\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sampleSignatureHashExample\""
}
],
"serviceInfo": {
"fileName": "../src/dev-team.js",
"serviceName": "devTeam"
}
},
{
"methods": [
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
}
],
"methodName": "loadEmailTemplates",
"description": "Load email templates for an application",
"methodLabel": "Load Email Templates",
"category": "Email",
"sampleResult": "[{\"eventId\":6,\"name\":\"Registration Confirmation\",\"triggersEmail\":true}]"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
}
],
"methodName": "loadCustomTemplates",
"description": "Load custom email templates for an application",
"methodLabel": "Load Custom Templates",
"category": "Email",
"sampleResult": "[]"
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "object",
"name": "payload",
"label": "Template Data",
"description": "Object containing template name, subject, and HTML body",
"properties": [
{
"name": "name",
"label": "Template Name",
"type": "string",
"optional": true,
"description": "The name of the custom email template"
},
{
"name": "subject",
"label": "Subject",
"type": "string",
"optional": true,
"description": "The email subject line"
},
{
"name": "body",
"label": "HTML Body",
"type": "string",
"optional": true,
"description": "The HTML content of the email template. Use {{variableName}} for template variables that can be replaced when sending emails"
}
],
"expandedFromTypedef": "createCustomTemplate__payload",
"optional": true
}
],
"methodName": "createCustomTemplate",
"description": "Create a new custom email template",
"methodLabel": "Create Custom Template",
"category": "Email",
"sampleResult": "\"\""
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "object",
"name": "payload",
"label": "Template Data",
"description": "Object containing template name, subject, and HTML body",
"properties": [
{
"name": "name",
"label": "Template Name",
"type": "string",
"optional": true,
"description": "The name of the email template"
},
{
"name": "subject",
"label": "Subject",
"type": "string",
"optional": true,
"description": "The email subject line"
},
{
"name": "body",
"label": "Body",
"type": "string",
"optional": true,
"description": "The HTML content of the email template. Use {{variableName}} for template variables that can be replaced when sending emails"
},
{
"name": "attachments",
"label": "Attachments",
"type": "array",
"optional": true,
"description": "Array of email attachments (optional)"
}
],
"expandedFromTypedef": "updateCustomTemplate__payload",
"optional": true
},
{
"type": "string",
"name": "templateName",
"label": "Template Name",
"description": "The name of the template to update",
"optional": true
}
],
"methodName": "updateCustomTemplate",
"description": "Update an existing custom email template",
"methodLabel": "Update Custom Template",
"category": "Email",
"sampleResult": "\"\""
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "templateName",
"label": "Template Name",
"description": "The name of the template to delete",
"optional": true
}
],
"methodName": "deleteCustomTemplate",
"description": "Delete a custom email template",
"methodLabel": "Delete Custom Template",
"category": "Email",
"sampleResult": "\"\""
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "object",
"name": "payload",
"label": "Email Data",
"description": "Object containing template name, variables, attachments, and recipient email",
"properties": [
{
"name": "template-name",
"label": "Template Name",
"type": "string",
"optional": true,
"description": "The name of the custom email template to use"
},
{
"name": "template-values",
"label": "Template Values",
"type": "sendtestcustomemail__templatevalues",
"optional": true,
"description": "Object containing template variables to replace in HTML. For {{key}} in HTML, provide key: 'value'"
},
{
"name": "attachment",
"label": "Attachments",
"type": "array",
"optional": true,
"description": "Array of file paths from Backendless Files service (e.g., ['folder/file.pdf', 'image.jpg'])"
},
{
"name": "email",
"label": "Recipient Email",
"type": "string",
"optional": true,
"description": "Email address to send the test email to"
}
],
"expandedFromTypedef": "sendTestCustomEmail__payload",
"optional": true
}
],
"methodName": "sendTestCustomEmail",
"description": "Send a test email using a custom template. Template variables in HTML like {{key}} will be replaced with values from template-values object.",
"methodLabel": "Send Test Custom Email",
"category": "Email",
"sampleResult": "\"\""
},
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "object",
"name": "payload",
"label": "Template Data",
"description": "Object containing template name, subject, and HTML body to extract variables from",
"properties": [
{
"name": "name",
"label": "Template Name",
"type": "string",
"optional": true,
"description": "The name of the email template to parse"
},
{
"name": "subject",
"label": "Subject",
"type": "string",
"optional": true,
"description": "The email subject line"
},
{
"name": "body",
"label": "HTML Body",
"type": "string",
"optional": true,
"description": "The HTML content of the email template to extract variables from"
},
{
"name": "attachments",
"label": "Attachments",
"type": "array",
"optional": true,
"description": "Array of email attachments (optional)"
}
],
"expandedFromTypedef": "parseCustomTemplateKeys__payload",
"optional": true
}
],
"methodName": "parseCustomTemplateKeys",
"description": "Parse and validate custom template keys",
"methodLabel": "Parse Custom Template Keys",
"category": "Email",
"sampleResult": "[\"username\",\"email\",\"date\"]"
}
],
"serviceInfo": {
"fileName": "../src/email.js",
"serviceName": "email"
}
},
{
"methods": [
{
"params": [
{
"type": "string",
"name": "appId",
"label": "Application ID",
"description": "The identifier of the application",
"optional": true
},
{
"type": "string",
"name": "path",
"label": "Path",
"description": "The directory path to load. If not specified, root path will be used",
"optional": true
},
{
"type": "object",
"name": "params",
"label": "Par