@oomol-lab/open-connector 1.9.0 → 1.9.1

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

@@ -0,0 +1,654 @@
+{
+  "service": "bainiu",
+  "displayName": "Bainiu",
+  "homepageUrl": "https://api.bainiudata.com/",
+  "categories": [
+    "Data & Analytics"
+  ],
+  "authTypes": [
+    "api_key"
+  ],
+  "auth": [
+    {
+      "type": "api_key",
+      "label": "Client Key",
+      "placeholder": "Your Bainiu Client Key",
+      "description": "Copy Client Key from your personal center at https://api.bainiudata.com/. Connecting checks required fields only; credentials and permissions are verified on your first API request. Queries may consume provider credits.",
+      "extraFields": [
+        {
+          "key": "clientId",
+          "label": "Client ID",
+          "required": true,
+          "description": "Copy Client ID from your personal center at https://api.bainiudata.com/. Used with Client Key to sign requests.",
+          "inputType": "password",
+          "secret": true
+        }
+      ]
+    }
+  ],
+  "actions": [
+    {
+      "id": "bainiu.get_company",
+      "service": "bainiu",
+      "name": "get_company",
+      "description": "Read company registration and business information. Queries may consume provider credits.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Company identifier, name, unified social credit code, registration number or organization code."
+          },
+          "key_type": {
+            "type": "string",
+            "enum": [
+              "0",
+              "1",
+              "2",
+              "3",
+              "4"
+            ],
+            "description": "Identifier type: 0 entity ID (default), 1 company name, 2 unified social credit code, 3 registration number, 4 organization code."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "key"
+        ],
+        "description": "Company detail lookup parameters."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "code": {
+            "type": "string",
+            "description": "Upstream response code; 200 indicates success."
+          },
+          "message": {
+            "type": "string",
+            "description": "Upstream response message."
+          },
+          "result": {
+            "type": "object",
+            "properties": {
+              "versions": {
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "description": "Detail node code."
+                },
+                "description": "Returned detail node codes."
+              },
+              "basic": {
+                "type": "object",
+                "properties": {},
+                "additionalProperties": true,
+                "description": "One upstream company record, including provider-specific fields."
+              }
+            },
+            "additionalProperties": true,
+            "description": "Requested company detail nodes."
+          },
+          "ordernum": {
+            "type": "string",
+            "description": "Upstream request or order identifier."
+          },
+          "is_verify": {
+            "type": "string",
+            "description": "Billing indicator: 0 not charged, 1 charged."
+          }
+        },
+        "additionalProperties": true,
+        "required": [
+          "code",
+          "message",
+          "result"
+        ],
+        "description": "Bainiu response envelope; upstream fields are preserved."
+      }
+    },
+    {
+      "id": "bainiu.list_company_branches",
+      "service": "bainiu",
+      "name": "list_company_branches",
+      "description": "List company branches with pagination. Queries may consume provider credits.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Company identifier, name, unified social credit code, registration number or organization code."
+          },
+          "key_type": {
+            "type": "string",
+            "enum": [
+              "0",
+              "1",
+              "2",
+              "3",
+              "4"
+            ],
+            "description": "Identifier type: 0 entity ID (default), 1 company name, 2 unified social credit code, 3 registration number, 4 organization code."
+          },
+          "page_index": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "Page number, starting at 1. Omit for the provider default."
+          },
+          "page_size": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "Number of records per page. Omit for the provider default."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "key"
+        ],
+        "description": "Company detail lookup parameters."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "code": {
+            "type": "string",
+            "description": "Upstream response code; 200 indicates success."
+          },
+          "message": {
+            "type": "string",
+            "description": "Upstream response message."
+          },
+          "result": {
+            "type": "object",
+            "properties": {
+              "versions": {
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "description": "Detail node code."
+                },
+                "description": "Returned detail node codes."
+              },
+              "filiation": {
+                "type": "object",
+                "properties": {
+                  "datalist": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {},
+                      "additionalProperties": true,
+                      "description": "One upstream company record, including provider-specific fields."
+                    },
+                    "description": "Records on this page."
+                  },
+                  "total": {
+                    "type": "integer",
+                    "description": "Total matching records."
+                  }
+                },
+                "additionalProperties": true,
+                "description": "A page of upstream records."
+              }
+            },
+            "additionalProperties": true,
+            "description": "Requested company detail nodes."
+          },
+          "ordernum": {
+            "type": "string",
+            "description": "Upstream request or order identifier."
+          },
+          "is_verify": {
+            "type": "string",
+            "description": "Billing indicator: 0 not charged, 1 charged."
+          }
+        },
+        "additionalProperties": true,
+        "required": [
+          "code",
+          "message",
+          "result"
+        ],
+        "description": "Bainiu response envelope; upstream fields are preserved."
+      }
+    },
+    {
+      "id": "bainiu.list_company_changes",
+      "service": "bainiu",
+      "name": "list_company_changes",
+      "description": "List company registration changes with optional type and date filters. Queries may consume provider credits.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Company identifier, name, unified social credit code, registration number or organization code."
+          },
+          "key_type": {
+            "type": "string",
+            "enum": [
+              "0",
+              "1",
+              "2",
+              "3",
+              "4"
+            ],
+            "description": "Identifier type: 0 entity ID (default), 1 company name, 2 unified social credit code, 3 registration number, 4 organization code."
+          },
+          "page_index": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "Page number, starting at 1. Omit for the provider default."
+          },
+          "page_size": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "Number of records per page. Omit for the provider default."
+          },
+          "alttype": {
+            "type": "string",
+            "description": "Upstream change type code, for example 01 name, 03 representative, 10 business scope or 20 registered capital."
+          },
+          "altdate_start": {
+            "type": "string",
+            "description": "Inclusive change date lower bound (YYYY-MM-DD).",
+            "format": "date"
+          },
+          "altdate_end": {
+            "type": "string",
+            "description": "Exclusive change date upper bound (YYYY-MM-DD).",
+            "format": "date"
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "key"
+        ],
+        "description": "Company detail lookup parameters."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "code": {
+            "type": "string",
+            "description": "Upstream response code; 200 indicates success."
+          },
+          "message": {
+            "type": "string",
+            "description": "Upstream response message."
+          },
+          "result": {
+            "type": "object",
+            "properties": {
+              "versions": {
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "description": "Detail node code."
+                },
+                "description": "Returned detail node codes."
+              },
+              "alter": {
+                "type": "object",
+                "properties": {
+                  "datalist": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {},
+                      "additionalProperties": true,
+                      "description": "One upstream company record, including provider-specific fields."
+                    },
+                    "description": "Records on this page."
+                  },
+                  "total": {
+                    "type": "integer",
+                    "description": "Total matching records."
+                  }
+                },
+                "additionalProperties": true,
+                "description": "A page of upstream records."
+              }
+            },
+            "additionalProperties": true,
+            "description": "Requested company detail nodes."
+          },
+          "ordernum": {
+            "type": "string",
+            "description": "Upstream request or order identifier."
+          },
+          "is_verify": {
+            "type": "string",
+            "description": "Billing indicator: 0 not charged, 1 charged."
+          }
+        },
+        "additionalProperties": true,
+        "required": [
+          "code",
+          "message",
+          "result"
+        ],
+        "description": "Bainiu response envelope; upstream fields are preserved."
+      }
+    },
+    {
+      "id": "bainiu.list_company_shareholders",
+      "service": "bainiu",
+      "name": "list_company_shareholders",
+      "description": "List company shareholders and managers with pagination. Queries may consume provider credits.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Company identifier, name, unified social credit code, registration number or organization code."
+          },
+          "key_type": {
+            "type": "string",
+            "enum": [
+              "0",
+              "1",
+              "2",
+              "3",
+              "4"
+            ],
+            "description": "Identifier type: 0 entity ID (default), 1 company name, 2 unified social credit code, 3 registration number, 4 organization code."
+          },
+          "page_index": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "Page number, starting at 1. Omit for the provider default."
+          },
+          "page_size": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "Number of records per page. Omit for the provider default."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "key"
+        ],
+        "description": "Company detail lookup parameters."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "code": {
+            "type": "string",
+            "description": "Upstream response code; 200 indicates success."
+          },
+          "message": {
+            "type": "string",
+            "description": "Upstream response message."
+          },
+          "result": {
+            "type": "object",
+            "properties": {
+              "versions": {
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "description": "Detail node code."
+                },
+                "description": "Returned detail node codes."
+              },
+              "shareholder": {
+                "type": "object",
+                "properties": {
+                  "datalist": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {},
+                      "additionalProperties": true,
+                      "description": "One upstream company record, including provider-specific fields."
+                    },
+                    "description": "Records on this page."
+                  },
+                  "total": {
+                    "type": "integer",
+                    "description": "Total matching records."
+                  }
+                },
+                "additionalProperties": true,
+                "description": "A page of upstream records."
+              },
+              "person": {
+                "type": "object",
+                "properties": {
+                  "datalist": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {},
+                      "additionalProperties": true,
+                      "description": "One upstream company record, including provider-specific fields."
+                    },
+                    "description": "Records on this page."
+                  },
+                  "total": {
+                    "type": "integer",
+                    "description": "Total matching records."
+                  }
+                },
+                "additionalProperties": true,
+                "description": "A page of upstream records."
+              }
+            },
+            "additionalProperties": true,
+            "description": "Requested company detail nodes."
+          },
+          "ordernum": {
+            "type": "string",
+            "description": "Upstream request or order identifier."
+          },
+          "is_verify": {
+            "type": "string",
+            "description": "Billing indicator: 0 not charged, 1 charged."
+          }
+        },
+        "additionalProperties": true,
+        "required": [
+          "code",
+          "message",
+          "result"
+        ],
+        "description": "Bainiu response envelope; upstream fields are preserved."
+      }
+    },
+    {
+      "id": "bainiu.resolve_companies",
+      "service": "bainiu",
+      "name": "resolve_companies",
+      "description": "Resolve company identifiers in a batch. Separate multiple lookup keys with commas; queries may consume provider credits.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Company identifier, name, unified social credit code, registration number or organization code."
+          },
+          "key_type": {
+            "type": "string",
+            "enum": [
+              "0",
+              "1",
+              "2",
+              "3",
+              "4"
+            ],
+            "description": "Identifier type: 0 entity ID (default), 1 company name, 2 unified social credit code, 3 registration number, 4 organization code."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "key"
+        ],
+        "description": "Company identifier lookup parameters."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "code": {
+            "type": "string",
+            "description": "Upstream response code; 200 indicates success."
+          },
+          "message": {
+            "type": "string",
+            "description": "Upstream response message."
+          },
+          "result": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "description": "Company entity ID."
+            },
+            "description": "Mapping from each lookup key to its entity ID."
+          },
+          "ordernum": {
+            "type": "string",
+            "description": "Upstream request or order identifier."
+          },
+          "is_verify": {
+            "type": "string",
+            "description": "Billing indicator: 0 not charged, 1 charged."
+          }
+        },
+        "additionalProperties": true,
+        "required": [
+          "code",
+          "message",
+          "result"
+        ],
+        "description": "Bainiu response envelope; upstream fields are preserved."
+      }
+    },
+    {
+      "id": "bainiu.search_companies",
+      "service": "bainiu",
+      "name": "search_companies",
+      "description": "Search companies using Bainiu's DSL with filters, sorting, highlighting and pagination. Queries may consume provider credits.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "type": "object",
+            "properties": {
+              "dsl_query": {
+                "type": "object",
+                "properties": {},
+                "additionalProperties": true,
+                "description": "Bainiu filter tree, using must/should and field operators any/all/not/range/exist. Example: {\"must\":[{\"main__ENTNAME\":{\"all\":[\"小米\"]}}]}."
+              },
+              "sort": {
+                "type": "object",
+                "properties": {},
+                "additionalProperties": true,
+                "description": "Upstream sort configuration, including algorithm or geographical sorting."
+              },
+              "highlight": {
+                "type": "object",
+                "properties": {},
+                "additionalProperties": true,
+                "description": "Upstream highlight configuration."
+              },
+              "page_index": {
+                "type": "integer",
+                "minimum": 1,
+                "description": "Page number, starting at 1. Omit for the provider default."
+              },
+              "page_size": {
+                "type": "integer",
+                "minimum": 1,
+                "description": "Number of records per page. Omit for the provider default."
+              }
+            },
+            "additionalProperties": true,
+            "required": [
+              "dsl_query"
+            ],
+            "description": "Search request encoded as JSON by Connector. Supports the full upstream query DSL and additional provider options."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "data"
+        ],
+        "description": "Company search parameters."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "code": {
+            "type": "string",
+            "description": "Upstream response code; 200 indicates success."
+          },
+          "message": {
+            "type": "string",
+            "description": "Upstream response message."
+          },
+          "result": {
+            "type": "object",
+            "properties": {
+              "datalist": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {},
+                  "additionalProperties": true,
+                  "description": "One upstream company record, including provider-specific fields."
+                },
+                "description": "Records on this page."
+              },
+              "total": {
+                "type": "integer",
+                "description": "Total matching records."
+              }
+            },
+            "additionalProperties": true,
+            "description": "A page of upstream records."
+          },
+          "ordernum": {
+            "type": "string",
+            "description": "Upstream request or order identifier."
+          },
+          "is_verify": {
+            "type": "string",
+            "description": "Billing indicator: 0 not charged, 1 charged."
+          }
+        },
+        "additionalProperties": true,
+        "required": [
+          "code",
+          "message",
+          "result"
+        ],
+        "description": "Bainiu response envelope; upstream fields are preserved."
+      }
+    }
+  ]
+}