@arbium/enterprise-agent-connect 0.1.2-dev.d2aa5ca → 0.2.1-dev.7b4e802

package/dist/connectors/druva/connector.json

@@ -0,0 +1,258 @@
+{
+  "id": "druva",
+  "name": "Druva",
+  "description": "Let agents read which laptops and desktops Druva backs up, when each last backed up and who owns it. For checking that every device is protected.",
+  "logo": "/brand/registry/druva.svg",
+  "identity": "Druva API credentials (a client ID and secret key), restricted to an inSync role that can only view. For Druva's commercial cloud.",
+  "accountKey": "host",
+  "connectionKind": "guided",
+  "setup": [
+    {
+      "title": "Create API credentials",
+      "body": "You need a Druva Cloud Administrator for this. Unrestricted credentials can use every Druva API, including changes and deletes, so restrict them to an inSync custom role that can only view users, devices and backups. Copy both values when Druva shows them; to see the secret again you must generate a new one.",
+      "link": {
+        "label": "Druva: create and manage API credentials",
+        "href": "https://help.druva.com/en/articles/8580838-create-and-manage-api-credentials"
+      },
+      "click": [
+        "In the Druva Cloud Platform Console, open Global Navigation, then Integration Center.",
+        "Select API Credentials in the left panel, then New Credentials.",
+        "Enter a name, such as AI agents, and optionally restrict the networks it may be used from.",
+        "Select Save, then copy the Client ID and Secret Key from Credential Details.",
+        "Select the new credentials, then Edit.",
+        "Under authorization restrictions, choose Product Administrator, then for inSync a custom role that can only view users, devices and backups, and select Save."
+      ]
+    }
+  ],
+  "afterConnect": [],
+  "fields": [
+    {
+      "id": "client_id",
+      "label": "Client ID",
+      "secret": false
+    },
+    {
+      "id": "secret_key",
+      "label": "Secret Key",
+      "secret": true
+    }
+  ],
+  "capabilities": [
+    {
+      "id": "read",
+      "label": "Read devices and backups",
+      "description": "List backed-up devices by user, name, serial number, operating system or last connection, read one device, list each device's last successful backup, and look up users by name or email.",
+      "required": true,
+      "note": "Reaches every device and user in Druva Endpoints. Read-only.",
+      "scopes": [],
+      "permissions": [],
+      "tools": ["druva_list_devices", "druva_get_device", "druva_list_last_backups", "druva_list_users"]
+    }
+  ],
+  "limits": [],
+  "verify": {
+    "method": "GET",
+    "path": "/usermanagement/v1/users",
+    "label": "Druva users",
+    "show": "totalSize"
+  },
+  "revoke": "In the Druva Cloud Platform Console, go to Integration Center, then API Credentials, and delete the credentials. Agents lose access to Druva at once.",
+  "http": {
+    "baseUrl": "https://apis.druva.com/insync",
+    "auth": {
+      "type": "oauth2",
+      "tokenUrl": "https://apis.druva.com/token",
+      "clientId": "client_id",
+      "clientSecret": "secret_key",
+      "clientAuth": "basic",
+      "scope": "read"
+    },
+    "tools": [
+      {
+        "name": "druva_list_devices",
+        "description": "List the devices Druva backs up, filtered by owner, name, serial number, operating system, status or when they last connected.",
+        "method": "GET",
+        "path": "/endpoints/v2/devices",
+        "params": {
+          "user_id": {
+            "type": "integer",
+            "description": "Only this user's devices (the userID from the list of users)",
+            "in": "query",
+            "name": "userID",
+            "required": false
+          },
+          "name_prefix": {
+            "type": "string",
+            "description": "Only devices whose name starts with this",
+            "in": "query",
+            "name": "searchPrefixDeviceName",
+            "required": false
+          },
+          "serial_number": {
+            "type": "string",
+            "description": "Only the device with this hardware serial number",
+            "in": "query",
+            "name": "serialNumber",
+            "required": false
+          },
+          "platform": {
+            "type": "string",
+            "enum": ["win32", "linux2", "darwin", "android", "ios"],
+            "description": "Only devices on this platform",
+            "in": "query",
+            "name": "platformOS",
+            "required": false
+          },
+          "status": {
+            "type": "string",
+            "enum": ["enabled", "disabled"],
+            "description": "Only enabled or disabled devices",
+            "in": "query",
+            "name": "deviceStatus",
+            "required": false
+          },
+          "last_connected_before": {
+            "type": "string",
+            "description": "Only devices last connected before this time, as YYYY-MM-DDTHH:MM:SSZ",
+            "in": "query",
+            "name": "maxLastConnected",
+            "required": false
+          },
+          "page_token": {
+            "type": "string",
+            "description": "The next value from the previous page; leave out for the first page",
+            "in": "query",
+            "name": "pageToken",
+            "required": false
+          }
+        },
+        "result": {
+          "items": "devices",
+          "fields": [
+            "deviceID",
+            "deviceName",
+            "userID",
+            "serialNumber",
+            "platformOS",
+            "deviceOS",
+            "deviceOSVersion",
+            "deviceStatus",
+            "deviceMarkedInactive",
+            "lastConnected",
+            "clientVersion",
+            "upgradeState",
+            "totalBackupData"
+          ]
+        },
+        "paging": { "param": "page_token", "body": "nextPageToken" }
+      },
+      {
+        "name": "druva_get_device",
+        "description": "Read one device: owner, operating system, serial number, status, last connection, backup client version and total data backed up.",
+        "method": "GET",
+        "path": "/endpoints/v2/devices/{device_id}",
+        "params": {
+          "device_id": {
+            "type": "integer",
+            "description": "The deviceID",
+            "in": "path"
+          }
+        }
+      },
+      {
+        "name": "druva_list_last_backups",
+        "description": "List each device's last successful backup: when it started and ended, files backed up and files missed. Filter by device, user or when the backup ended.",
+        "method": "GET",
+        "path": "/endpoints/v1/backups",
+        "params": {
+          "last_successful": {
+            "type": "boolean",
+            "enum": [true],
+            "description": "Always true: the last successful backup",
+            "in": "query",
+            "name": "lastSuccessful",
+            "default": true
+          },
+          "device_id": {
+            "type": "integer",
+            "description": "Only this device",
+            "in": "query",
+            "name": "deviceID",
+            "required": false
+          },
+          "user_id": {
+            "type": "integer",
+            "description": "Only this user's devices",
+            "in": "query",
+            "name": "userID",
+            "required": false
+          },
+          "ended_before": {
+            "type": "string",
+            "description": "Only backups that ended before this time, as YYYY-MM-DDTHH:MM:SSZ, to find devices not backed up lately",
+            "in": "query",
+            "name": "maxBackupEndTime",
+            "required": false
+          },
+          "page_token": {
+            "type": "string",
+            "description": "The next value from the previous page; leave out for the first page",
+            "in": "query",
+            "name": "pageToken",
+            "required": false
+          }
+        },
+        "result": {
+          "items": "backups",
+          "fields": ["deviceID", "backupStatus", "startTime", "endTime", "filesBackedUp", "filesMissed", "bytesTransferred"]
+        },
+        "paging": { "param": "page_token", "body": "nextPageToken" }
+      },
+      {
+        "name": "druva_list_users",
+        "description": "Find Druva users by email, email prefix or name prefix, with their status (active or preserved).",
+        "method": "GET",
+        "path": "/usermanagement/v1/users",
+        "params": {
+          "email": {
+            "type": "string",
+            "description": "The user's exact email address",
+            "in": "query",
+            "name": "emailID",
+            "required": false
+          },
+          "email_prefix": {
+            "type": "string",
+            "description": "Only users whose email starts with this",
+            "in": "query",
+            "name": "searchPrefixEmailID",
+            "required": false
+          },
+          "name_prefix": {
+            "type": "string",
+            "description": "Only users whose name starts with this",
+            "in": "query",
+            "name": "searchPrefixUserName",
+            "required": false
+          },
+          "status": {
+            "type": "string",
+            "enum": ["active", "preserved"],
+            "description": "Only users in this status",
+            "in": "query",
+            "required": false
+          },
+          "page_token": {
+            "type": "string",
+            "description": "The next value from the previous page; leave out for the first page",
+            "in": "query",
+            "name": "pageToken",
+            "required": false
+          }
+        },
+        "result": { "items": "users", "fields": ["userID", "userName", "emailID", "status", "profileID", "addedOn"] },
+        "paging": { "param": "page_token", "body": "nextPageToken" }
+      }
+    ]
+  }
+}

package/dist/connectors/dynamics-365/connector.json

@@ -22,7 +22,22 @@
         "Select Settings, then Users + permissions, then Security roles, and select New role.",
         "Name it {brand.microsoft.appName} agents, keep the root business unit and select Save.",
         "For each privilege above, find its table (Account, Contact, Opportunity, Case, Activity, Note, User) and set that privilege's access level. Leave everything else at None and select Save."
-      ]
+      ],
+      "copy": [
+        "# Needs the Azure CLI, signed in as a Dynamics 365 system administrator. Replace the address with your environment URL.",
+        "$environment = 'https://your-org.crm.dynamics.com'",
+        "$api = \"$environment/api/data/v9.2\"",
+        "$headers = @{ Authorization = \"Bearer $(az account get-access-token --resource $environment --query accessToken -o tsv)\"; 'Content-Type' = 'application/json' }",
+        "$root = (Invoke-RestMethod -Headers $headers \"$api/businessunits?`$filter=_parentbusinessunitid_value eq null&`$select=businessunitid\").value[0].businessunitid",
+        "$role = Invoke-RestMethod -Method Post -Headers ($headers + @{ Prefer = 'return=representation' }) \"$api/roles\" -Body (@{ name = '{brand.microsoft.appName} agents'; 'businessunitid@odata.bind' = \"/businessunits($root)\" } | ConvertTo-Json)",
+        "# Global is Organization access; use Local to keep agents to the business unit.",
+        "$names = @(",
+        "  '{scope}'",
+        ")",
+        "$privileges = foreach ($name in $names) { @{ PrivilegeId = (Invoke-RestMethod -Headers $headers \"$api/privileges?`$filter=name eq '$name'&`$select=privilegeid\").value[0].privilegeid; Depth = 'Global'; BusinessUnitId = $root } }",
+        "Invoke-RestMethod -Method Post -Headers $headers \"$api/roles($($role.roleid))/Microsoft.Dynamics.CRM.AddPrivilegesRole\" -Body (@{ Privileges = @($privileges) } | ConvertTo-Json -Depth 4)"
+      ],
+      "shell": "powershell"
     },
     {
       "title": "Add the app as an application user",

package/dist/connectors/dynamics-365/index.d.ts

@@ -1,9 +1,6 @@
 declare const _default: {
     id: string;
-    create: ({ microsoft }: {
-        microsoft: import("../microsoft/client.js").MicrosoftClient;
-        connector: import("../../packages/connector-kit/src/connector.js").Connector;
-    }) => {
+    create: ({ microsoft }: import("../microsoft/client.js").BuiltinContext) => {
         vendor: import("../../packages/connector-kit/src/types.js").Vendor;
         toolset: import("../../packages/connector-kit/src/common.js").Toolset;
     };

package/dist/connectors/dynamics-365/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../connectors/dynamics-365/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,eAAe;IACb,EAAE,EAAE,cAAc;IAClB,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1B,MAAM,EAAE,cAAc,CAAC,SAAS,CAAC;QACjC,OAAO,EAAE,aAAa;KACvB,CAAC;CACuB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../connectors/dynamics-365/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,eAAe;IACb,EAAE,EAAE,cAAc;IAClB,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;QAC1B,MAAM,EAAE,cAAc,CAAC,SAAS,CAAC;QACjC,OAAO,EAAE,aAAa;KACvB,CAAC;CACqB,CAAC"}

package/dist/connectors/entra/index.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("../../packages/connector-kit/src/connector.js").ConnectorModule;
+declare const _default: import("../microsoft/client.js").BuiltinModule;
 export default _default;

package/dist/connectors/forsta-decipher/connector.json

@@ -0,0 +1,164 @@
+{
+  "id": "forsta-decipher",
+  "name": "Forsta Surveys (Decipher)",
+  "description": "Let agents keep track of your Forsta (Decipher) surveys: find surveys and their field status, read completes and drop-outs, quotas, the questionnaire's datamap and field warnings, and your company's usage for a period. Read-only.",
+  "logo": "/brand/registry/forsta-decipher.svg",
+  "identity": "A Decipher API key of a Research Hub user. It reaches the surveys that user can, with any limits set on the key, so create it under a user made for agents.",
+  "accountKey": "host",
+  "connectionKind": "guided",
+  "setup": [
+    {
+      "title": "Create an API key",
+      "body": "Create the key as a user who has access only to the projects agents should see. You can also limit the key to certain calls, networks and an expiry date. Keys work over https only.",
+      "link": {
+        "label": "Decipher API: authentication and authorization",
+        "href": "https://docs.developer.focusvision.com/docs/decipher/api"
+      },
+      "click": [
+        "In the Research Hub, open the User Links menu and select API access.",
+        "Select Create API key, set any restrictions you want, and copy the key."
+      ]
+    },
+    {
+      "title": "Find your server address",
+      "body": "Use the host name you sign in to the Research Hub at, such as yourcompany.decipherinc.com. The command below checks the key and address and changes nothing.",
+      "click": ["Copy the host name from your browser's address bar while signed in to the Research Hub."],
+      "copy": ["curl -s -H \"x-apikey: $DECIPHER_KEY\" \"https://$DECIPHER_HOST/api/v1/hello?name=agents\""],
+      "shell": "bash"
+    }
+  ],
+  "afterConnect": [],
+  "fields": [
+    {
+      "id": "host",
+      "label": "Server address",
+      "help": "The host name of your Research Hub, without https:// or a path.",
+      "placeholder": "yourcompany.decipherinc.com",
+      "secret": false
+    },
+    {
+      "id": "api_key",
+      "label": "API key",
+      "secret": true
+    }
+  ],
+  "capabilities": [
+    {
+      "id": "read_surveys",
+      "label": "Read surveys",
+      "description": "Find surveys with their state and completes, and read one survey's completes and drop-outs, quotas, datamap (its questions and answer codes) and field warnings.",
+      "required": true,
+      "note": "Reaches every survey the key's user can. Read-only.",
+      "scopes": [],
+      "permissions": [],
+      "tools": [
+        "decipher_list_surveys",
+        "decipher_get_survey",
+        "decipher_get_completions",
+        "decipher_get_quotas",
+        "decipher_get_datamap",
+        "decipher_get_warnings"
+      ]
+    },
+    {
+      "id": "read_usage",
+      "label": "Read usage",
+      "description": "Read your company's usage for a date range, the completes your bill is based on, by project and device type.",
+      "scopes": [],
+      "permissions": [],
+      "tools": ["decipher_get_usage"]
+    }
+  ],
+  "limits": [],
+  "verify": {
+    "method": "GET",
+    "path": "/hello?name=agents",
+    "label": "Decipher answers",
+    "show": "hello"
+  },
+  "revoke": "In the Research Hub, open the User Links menu, select API access and delete the key. Agents lose access to Decipher at once.",
+  "http": {
+    "baseUrl": "https://{host}/api/v1",
+    "auth": { "type": "header", "header": "x-apikey", "value": "api_key" },
+    "tools": [
+      {
+        "name": "decipher_list_surveys",
+        "description": "Find surveys as in the Research Hub, by text, #tag or user:email. Each has its path (selfserve/<directory>/<project>), state, launch date and completes so far.",
+        "method": "GET",
+        "path": "/rh/companies/all/surveys",
+        "params": {
+          "query": { "type": "string", "description": "A Research Hub search, e.g. brand tracker, #wave3 or user:ann@example.com", "in": "query", "required": false }
+        },
+        "result": {
+          "fields": ["path", "title", "owner", "state", "tags", "directory", "dateLaunched", "startTime", "finishTime", "total", "qualified", "today", "clickthrough", "medianQtime", "questions"]
+        }
+      },
+      {
+        "name": "decipher_get_survey",
+        "description": "Read one survey's Research Hub record. Surveys are named by the two parts after selfserve/ in their path.",
+        "method": "GET",
+        "path": "/rh/surveys/selfserve/{directory}/{project}",
+        "params": {
+          "directory": { "type": "string", "description": "The part after selfserve/ in the survey's path, e.g. 53b", "in": "path" },
+          "project": { "type": "string", "description": "The last part of the survey's path, e.g. 180401", "in": "path" }
+        }
+      },
+      {
+        "name": "decipher_get_completions",
+        "description": "Read a survey's field summary: clickthroughs, partials, terminates, over-quotas and qualified completes, optionally split, e.g. by list.",
+        "method": "GET",
+        "path": "/surveys/selfserve/{directory}/{project}/summary/completions",
+        "params": {
+          "directory": { "type": "string", "description": "The part after selfserve/ in the survey's path", "in": "path" },
+          "project": { "type": "string", "description": "The last part of the survey's path", "in": "path" },
+          "split": { "type": "string", "description": "Split the counts by this, e.g. list", "in": "query", "required": false }
+        }
+      },
+      {
+        "name": "decipher_get_quotas",
+        "description": "Read a survey's quotas: each cell's limit, completes, pending and over-quota counts.",
+        "method": "GET",
+        "path": "/surveys/selfserve/{directory}/{project}/quota",
+        "params": {
+          "directory": { "type": "string", "description": "The part after selfserve/ in the survey's path", "in": "path" },
+          "project": { "type": "string", "description": "The last part of the survey's path", "in": "path" }
+        },
+        "result": { "fields": ["markers", "sheets", "defines", "stopped"] }
+      },
+      {
+        "name": "decipher_get_datamap",
+        "description": "Read a survey's datamap: its questions, variables and answer codes, for checking the questionnaire and the data.",
+        "method": "GET",
+        "path": "/surveys/selfserve/{directory}/{project}/datamap",
+        "params": {
+          "directory": { "type": "string", "description": "The part after selfserve/ in the survey's path", "in": "path" },
+          "project": { "type": "string", "description": "The last part of the survey's path", "in": "path" },
+          "format": { "type": "string", "description": "Always JSON", "in": "query", "enum": ["json"], "default": "json" }
+        }
+      },
+      {
+        "name": "decipher_get_warnings",
+        "description": "Read a survey's field warnings for a period: participants blocked, missing images or scripts, errors and quota misses.",
+        "method": "GET",
+        "path": "/surveys/selfserve/{directory}/{project}/warnings",
+        "params": {
+          "directory": { "type": "string", "description": "The part after selfserve/ in the survey's path", "in": "path" },
+          "project": { "type": "string", "description": "The last part of the survey's path", "in": "path" },
+          "start": { "type": "string", "description": "From this date, YYYY-MM-DD", "in": "query", "required": false },
+          "end": { "type": "string", "description": "Up to this date, YYYY-MM-DD", "in": "query", "required": false }
+        }
+      },
+      {
+        "name": "decipher_get_usage",
+        "description": "Read your company's usage between two dates: completes by project and by device type. Yesterday's data is ready a day or two later.",
+        "method": "GET",
+        "path": "/rh/usage",
+        "params": {
+          "start": { "type": "string", "description": "Start date, YYYY-MM-DD", "in": "query" },
+          "end": { "type": "string", "description": "End date, YYYY-MM-DD", "in": "query" },
+          "company": { "type": "integer", "description": "Only this company's usage", "in": "query", "required": false }
+        }
+      }
+    ]
+  }
+}