@oomol-lab/open-connector 1.6.2 → 1.6.3

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

@@ -0,0 +1,956 @@
+{
+  "service": "benchmarkone",
+  "displayName": "BenchmarkONE",
+  "description": "Manage BenchmarkONE contacts, companies, tasks, and marketing records.",
+  "categories": [
+    "Marketing",
+    "Productivity"
+  ],
+  "authTypes": [
+    "api_key"
+  ],
+  "auth": [
+    {
+      "type": "api_key",
+      "label": "API Key",
+      "placeholder": "BENCHMARKONE_API_KEY",
+      "description": "BenchmarkONE API key passed as the api_key query parameter. Generate it under Account Settings > Data > API: https://help.benchmarkone.com/en/articles/2383067-api-documentation-for-advanced-users"
+    }
+  ],
+  "homepageUrl": "https://www.benchmarkone.com/",
+  "actions": [
+    {
+      "id": "benchmarkone.create_contact",
+      "service": "benchmarkone",
+      "name": "create_contact",
+      "description": "Create a contact in BenchmarkONE.",
+      "operationType": "write",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "contact": {
+            "type": "object",
+            "properties": {
+              "contactId": {
+                "type": "string",
+                "description": "The encrypted contact ID. Required when updating a contact."
+              },
+              "firstName": {
+                "type": "string",
+                "description": "The contact's first name."
+              },
+              "lastName": {
+                "type": "string",
+                "description": "The contact's last name."
+              },
+              "title": {
+                "type": "string",
+                "description": "The contact's job title."
+              },
+              "company": {
+                "type": "string",
+                "description": "The contact's company name."
+              },
+              "emails": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "The encrypted email record ID when updating an existing email."
+                    },
+                    "address": {
+                      "type": "string",
+                      "minLength": 1,
+                      "description": "The email address.",
+                      "format": "email"
+                    },
+                    "type": {
+                      "type": "string",
+                      "description": "The configured email type name, such as work, home, or other."
+                    },
+                    "typeId": {
+                      "type": "string",
+                      "description": "The configured email type ID."
+                    }
+                  },
+                  "additionalProperties": false,
+                  "required": [
+                    "address"
+                  ],
+                  "description": "A BenchmarkONE email address attached to a contact."
+                },
+                "description": "The contact's email addresses."
+              },
+              "phones": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "The encrypted phone record ID when updating an existing phone."
+                    },
+                    "number": {
+                      "type": "string",
+                      "minLength": 1,
+                      "description": "The phone number."
+                    },
+                    "type": {
+                      "type": "string",
+                      "description": "The configured phone type name, such as work, home, or other."
+                    },
+                    "typeId": {
+                      "type": "string",
+                      "description": "The configured phone type ID."
+                    }
+                  },
+                  "additionalProperties": false,
+                  "required": [
+                    "number"
+                  ],
+                  "description": "A BenchmarkONE phone number attached to a contact."
+                },
+                "description": "The contact's phone numbers."
+              },
+              "status": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "The configured value name."
+                  },
+                  "id": {
+                    "type": "string",
+                    "description": "The encrypted configured value ID."
+                  }
+                },
+                "additionalProperties": false,
+                "description": "A BenchmarkONE configured value referenced by name or encrypted ID.",
+                "anyOf": [
+                  {
+                    "required": [
+                      "name"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "id"
+                    ]
+                  }
+                ]
+              },
+              "temperature": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "The configured value name."
+                  },
+                  "id": {
+                    "type": "string",
+                    "description": "The encrypted configured value ID."
+                  }
+                },
+                "additionalProperties": false,
+                "description": "A BenchmarkONE configured value referenced by name or encrypted ID.",
+                "anyOf": [
+                  {
+                    "required": [
+                      "name"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "id"
+                    ]
+                  }
+                ]
+              },
+              "salesRep": {
+                "type": "object",
+                "properties": {
+                  "username": {
+                    "type": "string",
+                    "description": "The sales representative username."
+                  },
+                  "id": {
+                    "type": "string",
+                    "description": "The encrypted sales representative ID."
+                  }
+                },
+                "additionalProperties": false,
+                "description": "A BenchmarkONE sales representative referenced by username or encrypted ID.",
+                "anyOf": [
+                  {
+                    "required": [
+                      "username"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "id"
+                    ]
+                  }
+                ]
+              },
+              "addresses": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "The encrypted address record ID when updating an existing address."
+                    },
+                    "street": {
+                      "type": "string",
+                      "description": "The street address."
+                    },
+                    "city": {
+                      "type": "string",
+                      "description": "The city."
+                    },
+                    "state": {
+                      "type": "string",
+                      "description": "The state or region."
+                    },
+                    "zip": {
+                      "type": "string",
+                      "description": "The postal code."
+                    },
+                    "country": {
+                      "type": "string",
+                      "description": "The country name from the BenchmarkONE country list."
+                    },
+                    "type": {
+                      "type": "string",
+                      "description": "The configured address type name, such as work or home."
+                    },
+                    "typeId": {
+                      "type": "string",
+                      "description": "The configured address type ID."
+                    }
+                  },
+                  "additionalProperties": false,
+                  "description": "A BenchmarkONE street address attached to a contact."
+                },
+                "description": "The contact's street addresses."
+              },
+              "subscribed": {
+                "type": "boolean",
+                "description": "Whether the contact opted in to email marketing."
+              },
+              "timezone": {
+                "type": "string",
+                "description": "The contact's timezone."
+              },
+              "source": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "The configured value name."
+                  },
+                  "id": {
+                    "type": "string",
+                    "description": "The encrypted configured value ID."
+                  }
+                },
+                "additionalProperties": false,
+                "description": "A BenchmarkONE configured value referenced by name or encrypted ID.",
+                "anyOf": [
+                  {
+                    "required": [
+                      "name"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "id"
+                    ]
+                  }
+                ]
+              },
+              "referredBy": {
+                "type": "string",
+                "description": "The optional name of the contact who made the referral."
+              },
+              "customFields": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string",
+                      "minLength": 1,
+                      "description": "The unique custom field name."
+                    },
+                    "type": {
+                      "type": "string",
+                      "minLength": 1,
+                      "description": "The custom field type, such as Text, Dropdown, MText, Number, or Date."
+                    },
+                    "value": {
+                      "type": "string",
+                      "description": "The custom field value serialized as a string."
+                    }
+                  },
+                  "additionalProperties": false,
+                  "description": "A BenchmarkONE custom field value."
+                },
+                "description": "The contact's custom field values."
+              }
+            },
+            "additionalProperties": false,
+            "description": "The BenchmarkONE contact fields to create or update."
+          }
+        },
+        "additionalProperties": false,
+        "description": "The input payload for creating a BenchmarkONE contact."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "contact": {
+            "type": "object",
+            "properties": {
+              "contactId": {
+                "type": "string",
+                "description": "The encrypted contact ID."
+              },
+              "firstName": {
+                "type": "string",
+                "description": "The contact's first name."
+              },
+              "lastName": {
+                "type": "string",
+                "description": "The contact's last name."
+              },
+              "title": {
+                "type": "string",
+                "description": "The contact's job title."
+              },
+              "company": {
+                "type": "string",
+                "description": "The contact's company name."
+              },
+              "emails": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {},
+                  "additionalProperties": true,
+                  "description": "An email record returned by BenchmarkONE."
+                },
+                "description": "The contact's email records."
+              },
+              "phones": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {},
+                  "additionalProperties": true,
+                  "description": "A phone record returned by BenchmarkONE."
+                },
+                "description": "The contact's phone records."
+              },
+              "subscribed": {
+                "type": "boolean",
+                "description": "Whether the contact opted in to email marketing."
+              }
+            },
+            "additionalProperties": true,
+            "description": "The contact object returned by BenchmarkONE. Stable top-level fields follow the official contact schema while additional upstream fields are preserved."
+          }
+        },
+        "additionalProperties": false,
+        "description": "The BenchmarkONE contact creation response."
+      }
+    },
+    {
+      "id": "benchmarkone.list_contact_sources",
+      "service": "benchmarkone",
+      "name": "list_contact_sources",
+      "description": "List contact sources configured in the BenchmarkONE account.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {},
+        "additionalProperties": false,
+        "description": "The input payload for list contact sources configured in the benchmarkone account."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "values": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "The encrypted configured value ID."
+                },
+                "name": {
+                  "type": "string",
+                  "description": "The configured value name."
+                }
+              },
+              "additionalProperties": true,
+              "description": "A configured BenchmarkONE account value."
+            },
+            "description": "The configured values returned by BenchmarkONE."
+          }
+        },
+        "additionalProperties": false,
+        "description": "The configured BenchmarkONE contact sources."
+      }
+    },
+    {
+      "id": "benchmarkone.list_contact_statuses",
+      "service": "benchmarkone",
+      "name": "list_contact_statuses",
+      "description": "List contact statuses configured in the BenchmarkONE account.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {},
+        "additionalProperties": false,
+        "description": "The input payload for list contact statuses configured in the benchmarkone account."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "values": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "The encrypted configured value ID."
+                },
+                "name": {
+                  "type": "string",
+                  "description": "The configured value name."
+                }
+              },
+              "additionalProperties": true,
+              "description": "A configured BenchmarkONE account value."
+            },
+            "description": "The configured values returned by BenchmarkONE."
+          }
+        },
+        "additionalProperties": false,
+        "description": "The configured BenchmarkONE contact statuses."
+      }
+    },
+    {
+      "id": "benchmarkone.list_contact_temperatures",
+      "service": "benchmarkone",
+      "name": "list_contact_temperatures",
+      "description": "List contact temperatures configured in the BenchmarkONE account.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {},
+        "additionalProperties": false,
+        "description": "The input payload for list contact temperatures configured in the benchmarkone account."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "values": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "The encrypted configured value ID."
+                },
+                "name": {
+                  "type": "string",
+                  "description": "The configured value name."
+                }
+              },
+              "additionalProperties": true,
+              "description": "A configured BenchmarkONE account value."
+            },
+            "description": "The configured values returned by BenchmarkONE."
+          }
+        },
+        "additionalProperties": false,
+        "description": "The configured BenchmarkONE contact temperatures."
+      }
+    },
+    {
+      "id": "benchmarkone.search_contacts",
+      "service": "benchmarkone",
+      "name": "search_contacts",
+      "description": "Search BenchmarkONE contacts by encrypted contact ID, name, or email address.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "contactId": {
+            "type": "string",
+            "description": "The encrypted contact ID to search for."
+          },
+          "firstName": {
+            "type": "string",
+            "description": "The contact first name to search for."
+          },
+          "lastName": {
+            "type": "string",
+            "description": "The contact last name to search for."
+          },
+          "emailAddresses": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "minLength": 1,
+              "description": "One email address to search for.",
+              "format": "email"
+            },
+            "description": "The email addresses to search for.",
+            "minItems": 1
+          }
+        },
+        "additionalProperties": false,
+        "description": "The contact search criteria. Provide at least one field."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "contacts": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "contactId": {
+                  "type": "string",
+                  "description": "The encrypted contact ID."
+                },
+                "firstName": {
+                  "type": "string",
+                  "description": "The contact's first name."
+                },
+                "lastName": {
+                  "type": "string",
+                  "description": "The contact's last name."
+                },
+                "title": {
+                  "type": "string",
+                  "description": "The contact's job title."
+                },
+                "company": {
+                  "type": "string",
+                  "description": "The contact's company name."
+                },
+                "emails": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {},
+                    "additionalProperties": true,
+                    "description": "An email record returned by BenchmarkONE."
+                  },
+                  "description": "The contact's email records."
+                },
+                "phones": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {},
+                    "additionalProperties": true,
+                    "description": "A phone record returned by BenchmarkONE."
+                  },
+                  "description": "The contact's phone records."
+                },
+                "subscribed": {
+                  "type": "boolean",
+                  "description": "Whether the contact opted in to email marketing."
+                }
+              },
+              "additionalProperties": true,
+              "description": "The contact object returned by BenchmarkONE. Stable top-level fields follow the official contact schema while additional upstream fields are preserved."
+            },
+            "description": "The matching contacts."
+          }
+        },
+        "additionalProperties": false,
+        "description": "The BenchmarkONE contact search response."
+      }
+    },
+    {
+      "id": "benchmarkone.update_contact",
+      "service": "benchmarkone",
+      "name": "update_contact",
+      "description": "Update a BenchmarkONE contact by encrypted contact ID.",
+      "operationType": "write",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "contactId": {
+            "type": "string",
+            "minLength": 1,
+            "description": "The encrypted ID of the contact to update."
+          },
+          "contact": {
+            "type": "object",
+            "properties": {
+              "contactId": {
+                "type": "string",
+                "description": "The encrypted contact ID. Required when updating a contact."
+              },
+              "firstName": {
+                "type": "string",
+                "description": "The contact's first name."
+              },
+              "lastName": {
+                "type": "string",
+                "description": "The contact's last name."
+              },
+              "title": {
+                "type": "string",
+                "description": "The contact's job title."
+              },
+              "company": {
+                "type": "string",
+                "description": "The contact's company name."
+              },
+              "emails": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "The encrypted email record ID when updating an existing email."
+                    },
+                    "address": {
+                      "type": "string",
+                      "minLength": 1,
+                      "description": "The email address.",
+                      "format": "email"
+                    },
+                    "type": {
+                      "type": "string",
+                      "description": "The configured email type name, such as work, home, or other."
+                    },
+                    "typeId": {
+                      "type": "string",
+                      "description": "The configured email type ID."
+                    }
+                  },
+                  "additionalProperties": false,
+                  "required": [
+                    "address"
+                  ],
+                  "description": "A BenchmarkONE email address attached to a contact."
+                },
+                "description": "The contact's email addresses."
+              },
+              "phones": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "The encrypted phone record ID when updating an existing phone."
+                    },
+                    "number": {
+                      "type": "string",
+                      "minLength": 1,
+                      "description": "The phone number."
+                    },
+                    "type": {
+                      "type": "string",
+                      "description": "The configured phone type name, such as work, home, or other."
+                    },
+                    "typeId": {
+                      "type": "string",
+                      "description": "The configured phone type ID."
+                    }
+                  },
+                  "additionalProperties": false,
+                  "required": [
+                    "number"
+                  ],
+                  "description": "A BenchmarkONE phone number attached to a contact."
+                },
+                "description": "The contact's phone numbers."
+              },
+              "status": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "The configured value name."
+                  },
+                  "id": {
+                    "type": "string",
+                    "description": "The encrypted configured value ID."
+                  }
+                },
+                "additionalProperties": false,
+                "description": "A BenchmarkONE configured value referenced by name or encrypted ID.",
+                "anyOf": [
+                  {
+                    "required": [
+                      "name"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "id"
+                    ]
+                  }
+                ]
+              },
+              "temperature": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "The configured value name."
+                  },
+                  "id": {
+                    "type": "string",
+                    "description": "The encrypted configured value ID."
+                  }
+                },
+                "additionalProperties": false,
+                "description": "A BenchmarkONE configured value referenced by name or encrypted ID.",
+                "anyOf": [
+                  {
+                    "required": [
+                      "name"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "id"
+                    ]
+                  }
+                ]
+              },
+              "salesRep": {
+                "type": "object",
+                "properties": {
+                  "username": {
+                    "type": "string",
+                    "description": "The sales representative username."
+                  },
+                  "id": {
+                    "type": "string",
+                    "description": "The encrypted sales representative ID."
+                  }
+                },
+                "additionalProperties": false,
+                "description": "A BenchmarkONE sales representative referenced by username or encrypted ID.",
+                "anyOf": [
+                  {
+                    "required": [
+                      "username"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "id"
+                    ]
+                  }
+                ]
+              },
+              "addresses": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "The encrypted address record ID when updating an existing address."
+                    },
+                    "street": {
+                      "type": "string",
+                      "description": "The street address."
+                    },
+                    "city": {
+                      "type": "string",
+                      "description": "The city."
+                    },
+                    "state": {
+                      "type": "string",
+                      "description": "The state or region."
+                    },
+                    "zip": {
+                      "type": "string",
+                      "description": "The postal code."
+                    },
+                    "country": {
+                      "type": "string",
+                      "description": "The country name from the BenchmarkONE country list."
+                    },
+                    "type": {
+                      "type": "string",
+                      "description": "The configured address type name, such as work or home."
+                    },
+                    "typeId": {
+                      "type": "string",
+                      "description": "The configured address type ID."
+                    }
+                  },
+                  "additionalProperties": false,
+                  "description": "A BenchmarkONE street address attached to a contact."
+                },
+                "description": "The contact's street addresses."
+              },
+              "subscribed": {
+                "type": "boolean",
+                "description": "Whether the contact opted in to email marketing."
+              },
+              "timezone": {
+                "type": "string",
+                "description": "The contact's timezone."
+              },
+              "source": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "The configured value name."
+                  },
+                  "id": {
+                    "type": "string",
+                    "description": "The encrypted configured value ID."
+                  }
+                },
+                "additionalProperties": false,
+                "description": "A BenchmarkONE configured value referenced by name or encrypted ID.",
+                "anyOf": [
+                  {
+                    "required": [
+                      "name"
+                    ]
+                  },
+                  {
+                    "required": [
+                      "id"
+                    ]
+                  }
+                ]
+              },
+              "referredBy": {
+                "type": "string",
+                "description": "The optional name of the contact who made the referral."
+              },
+              "customFields": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string",
+                      "minLength": 1,
+                      "description": "The unique custom field name."
+                    },
+                    "type": {
+                      "type": "string",
+                      "minLength": 1,
+                      "description": "The custom field type, such as Text, Dropdown, MText, Number, or Date."
+                    },
+                    "value": {
+                      "type": "string",
+                      "description": "The custom field value serialized as a string."
+                    }
+                  },
+                  "additionalProperties": false,
+                  "description": "A BenchmarkONE custom field value."
+                },
+                "description": "The contact's custom field values."
+              }
+            },
+            "additionalProperties": false,
+            "description": "The BenchmarkONE contact fields to create or update."
+          }
+        },
+        "additionalProperties": false,
+        "description": "The input payload for updating a BenchmarkONE contact."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "contact": {
+            "type": "object",
+            "properties": {
+              "contactId": {
+                "type": "string",
+                "description": "The encrypted contact ID."
+              },
+              "firstName": {
+                "type": "string",
+                "description": "The contact's first name."
+              },
+              "lastName": {
+                "type": "string",
+                "description": "The contact's last name."
+              },
+              "title": {
+                "type": "string",
+                "description": "The contact's job title."
+              },
+              "company": {
+                "type": "string",
+                "description": "The contact's company name."
+              },
+              "emails": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {},
+                  "additionalProperties": true,
+                  "description": "An email record returned by BenchmarkONE."
+                },
+                "description": "The contact's email records."
+              },
+              "phones": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {},
+                  "additionalProperties": true,
+                  "description": "A phone record returned by BenchmarkONE."
+                },
+                "description": "The contact's phone records."
+              },
+              "subscribed": {
+                "type": "boolean",
+                "description": "Whether the contact opted in to email marketing."
+              }
+            },
+            "additionalProperties": true,
+            "description": "The contact object returned by BenchmarkONE. Stable top-level fields follow the official contact schema while additional upstream fields are preserved."
+          }
+        },
+        "additionalProperties": false,
+        "description": "The BenchmarkONE contact update response."
+      }
+    }
+  ]
+}