@oomol-lab/open-connector 1.6.4 → 1.7.0

package/assets/open-connector/catalog/apps/proworkflow.json

@@ -0,0 +1,529 @@
+{
+  "service": "proworkflow",
+  "displayName": "ProWorkflow",
+  "description": "List, inspect, and update ProWorkflow projects and project items.",
+  "categories": [
+    "Productivity"
+  ],
+  "authTypes": [
+    "api_key"
+  ],
+  "auth": [
+    {
+      "type": "api_key",
+      "label": "API Key",
+      "placeholder": "xxxx-xxxx-xxxx-xxxx-PWFxxxx",
+      "description": "Create or view the API key under Settings > Integrations > API Keys. See https://help.proworkflow.com/en/articles/1817949-how-to-find-your-api-key."
+    }
+  ],
+  "homepageUrl": "https://www.proworkflow.com/",
+  "actions": [
+    {
+      "id": "proworkflow.get_project",
+      "service": "proworkflow",
+      "name": "get_project",
+      "description": "Get one ProWorkflow project by ID.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "projectId": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "The ProWorkflow project ID."
+          },
+          "fields": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Comma-separated fields to return, including explicitly named sub-resources when needed."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "projectId"
+        ],
+        "description": "Parameters for retrieving a ProWorkflow project."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "status": {
+            "type": "string",
+            "description": "The response status returned by ProWorkflow."
+          },
+          "data": {
+            "type": "object",
+            "properties": {},
+            "additionalProperties": true,
+            "description": "A ProWorkflow resource returned by the API."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "status",
+          "data"
+        ],
+        "description": "A ProWorkflow resource response."
+      }
+    },
+    {
+      "id": "proworkflow.get_project_item",
+      "service": "proworkflow",
+      "name": "get_project_item",
+      "description": "Get one ProWorkflow project item by ID.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "itemId": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "The ProWorkflow project item ID."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "itemId"
+        ],
+        "description": "Parameters for retrieving a ProWorkflow project item."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "status": {
+            "type": "string",
+            "description": "The response status returned by ProWorkflow."
+          },
+          "data": {
+            "type": "object",
+            "properties": {},
+            "additionalProperties": true,
+            "description": "A ProWorkflow resource returned by the API."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "status",
+          "data"
+        ],
+        "description": "A ProWorkflow resource response."
+      }
+    },
+    {
+      "id": "proworkflow.list_project_items",
+      "service": "proworkflow",
+      "name": "list_project_items",
+      "description": "List and search ProWorkflow project items with optional pagination and sorting.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "fields": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Comma-separated response fields to request from ProWorkflow."
+          },
+          "q": {
+            "type": "string",
+            "minLength": 1,
+            "description": "A fuzzy search term."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "active",
+              "complete",
+              "deleted",
+              "all"
+            ],
+            "description": "The ProWorkflow work-state filter."
+          },
+          "sortOrder": {
+            "type": "string",
+            "enum": [
+              "asc",
+              "desc"
+            ],
+            "description": "The result sort direction."
+          },
+          "pageNumber": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "The one-based page number. Provide pageSize with this field."
+          },
+          "pageSize": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "The number of results per page. Provide pageNumber with this field."
+          },
+          "includeTotalRows": {
+            "type": "boolean",
+            "description": "Whether ProWorkflow should calculate the total result count."
+          },
+          "sortBy": {
+            "type": "string",
+            "enum": [
+              "id",
+              "name",
+              "code",
+              "priority",
+              "startdate",
+              "duedate",
+              "completedate",
+              "status",
+              "sortorder"
+            ],
+            "description": "The project item field used for sorting."
+          },
+          "projectId": {
+            "type": "string",
+            "minLength": 1,
+            "description": "A project ID or comma-separated project IDs to filter by."
+          }
+        },
+        "additionalProperties": false,
+        "description": "Filters for listing ProWorkflow project items."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "status": {
+            "type": "string",
+            "description": "The response status returned by ProWorkflow."
+          },
+          "data": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {},
+              "additionalProperties": true,
+              "description": "A ProWorkflow resource returned by the API."
+            },
+            "description": "Resources returned by ProWorkflow."
+          },
+          "meta": {
+            "type": "object",
+            "properties": {},
+            "additionalProperties": true,
+            "description": "Pagination metadata returned by ProWorkflow."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "status",
+          "data",
+          "meta"
+        ],
+        "description": "A paginated ProWorkflow list response."
+      }
+    },
+    {
+      "id": "proworkflow.list_projects",
+      "service": "proworkflow",
+      "name": "list_projects",
+      "description": "List and search ProWorkflow projects with optional pagination and sorting.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "fields": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Comma-separated response fields to request from ProWorkflow."
+          },
+          "q": {
+            "type": "string",
+            "minLength": 1,
+            "description": "A fuzzy search term."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "active",
+              "complete",
+              "deleted",
+              "all"
+            ],
+            "description": "The ProWorkflow work-state filter."
+          },
+          "sortOrder": {
+            "type": "string",
+            "enum": [
+              "asc",
+              "desc"
+            ],
+            "description": "The result sort direction."
+          },
+          "pageNumber": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "The one-based page number. Provide pageSize with this field."
+          },
+          "pageSize": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "The number of results per page. Provide pageNumber with this field."
+          },
+          "includeTotalRows": {
+            "type": "boolean",
+            "description": "Whether ProWorkflow should calculate the total result count."
+          },
+          "sortBy": {
+            "type": "string",
+            "enum": [
+              "id",
+              "number",
+              "title",
+              "startdate",
+              "duedate",
+              "completedate",
+              "companyname",
+              "categoryname",
+              "priority"
+            ],
+            "description": "The project field used for sorting."
+          },
+          "companyId": {
+            "type": "string",
+            "minLength": 1,
+            "description": "A company ID or comma-separated company IDs to filter by."
+          }
+        },
+        "additionalProperties": false,
+        "description": "Filters for listing ProWorkflow projects."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "status": {
+            "type": "string",
+            "description": "The response status returned by ProWorkflow."
+          },
+          "data": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {},
+              "additionalProperties": true,
+              "description": "A ProWorkflow resource returned by the API."
+            },
+            "description": "Resources returned by ProWorkflow."
+          },
+          "meta": {
+            "type": "object",
+            "properties": {},
+            "additionalProperties": true,
+            "description": "Pagination metadata returned by ProWorkflow."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "status",
+          "data",
+          "meta"
+        ],
+        "description": "A paginated ProWorkflow list response."
+      }
+    },
+    {
+      "id": "proworkflow.update_project",
+      "service": "proworkflow",
+      "name": "update_project",
+      "description": "Update selected fields on a ProWorkflow project.",
+      "operationType": "write",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "projectId": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "The ProWorkflow project ID."
+          },
+          "title": {
+            "type": "string",
+            "minLength": 1,
+            "description": "The new project title."
+          },
+          "number": {
+            "type": "string",
+            "minLength": 1,
+            "description": "The new project number or reference code."
+          },
+          "description": {
+            "type": "string",
+            "description": "The new project description."
+          },
+          "startDate": {
+            "type": "string",
+            "description": "The new project start date.",
+            "format": "date"
+          },
+          "dueDate": {
+            "type": "string",
+            "description": "The new project due date.",
+            "format": "date"
+          },
+          "completedDate": {
+            "type": "string",
+            "description": "The new project completion date.",
+            "format": "date"
+          },
+          "priorityId": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "The new project priority ID."
+          },
+          "managerId": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "The contact ID of the new project manager."
+          },
+          "companyId": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "The client company ID for the project."
+          },
+          "notification": {
+            "type": "boolean",
+            "description": "Whether project notifications are enabled."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "projectId"
+        ],
+        "description": "Fields to update on a ProWorkflow project."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "status": {
+            "type": "string",
+            "description": "The response status returned by ProWorkflow."
+          },
+          "message": {
+            "type": "string",
+            "description": "The update result message returned by ProWorkflow."
+          },
+          "data": {
+            "type": "object",
+            "properties": {},
+            "additionalProperties": true,
+            "description": "Additional update result data returned by ProWorkflow."
+          }
+        },
+        "additionalProperties": true,
+        "required": [
+          "status"
+        ],
+        "description": "The ProWorkflow update response."
+      }
+    },
+    {
+      "id": "proworkflow.update_project_item",
+      "service": "proworkflow",
+      "name": "update_project_item",
+      "description": "Update selected fields on a ProWorkflow project item.",
+      "operationType": "write",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "itemId": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "The ProWorkflow project item ID."
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1,
+            "description": "The new project item name."
+          },
+          "code": {
+            "type": "string",
+            "minLength": 1,
+            "description": "The new project item code."
+          },
+          "description": {
+            "type": "string",
+            "description": "The new project item description."
+          },
+          "startDate": {
+            "type": "string",
+            "description": "The new project item start date.",
+            "format": "date"
+          },
+          "dueDate": {
+            "type": "string",
+            "description": "The new project item due date.",
+            "format": "date"
+          },
+          "completedDate": {
+            "type": "string",
+            "description": "The new project item completion date.",
+            "format": "date"
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "active",
+              "complete"
+            ],
+            "description": "The new project item work state."
+          },
+          "priorityId": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "The new project item priority ID."
+          },
+          "percentComplete": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 100,
+            "description": "The manually recorded completion percentage."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "itemId"
+        ],
+        "description": "Fields to update on a ProWorkflow project item."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "status": {
+            "type": "string",
+            "description": "The response status returned by ProWorkflow."
+          },
+          "message": {
+            "type": "string",
+            "description": "The update result message returned by ProWorkflow."
+          },
+          "data": {
+            "type": "object",
+            "properties": {},
+            "additionalProperties": true,
+            "description": "Additional update result data returned by ProWorkflow."
+          }
+        },
+        "additionalProperties": true,
+        "required": [
+          "status"
+        ],
+        "description": "The ProWorkflow update response."
+      }
+    }
+  ]
+}