@vercel/sdk
Version:
<p align="center"> <a href="https://vercel.com"> <img src="https://assets.vercel.com/image/upload/v1588805858/repositories/vercel/logo.png" height="96"> <h3 align="center">Vercel</h3> </a> <p align="center">Develop. Preview. Ship.</p> </p>
99 lines • 5.18 kB
TypeScript
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
import { ConnectConnector } from "../models/connectconnector.js";
import { ConnectConnectorCreateResult } from "../models/connectconnectorcreateresult.js";
import { ConnectConnectorList } from "../models/connectconnectorlist.js";
import { ConnectConnectorProjectConnectionList } from "../models/connectconnectorprojectconnectionlist.js";
import { ConnectConnectorUpdateResult } from "../models/connectconnectorupdateresult.js";
import { ConnectProjectConnection } from "../models/connectprojectconnection.js";
import { ConnectProjectConnectorConnectionList } from "../models/connectprojectconnectorconnectionlist.js";
import { CreateConnectorRequest } from "../models/createconnectorop.js";
import { DeleteConnectorRequest } from "../models/deleteconnectorop.js";
import { DeleteConnectorProjectConnectionRequest } from "../models/deleteconnectorprojectconnectionop.js";
import { GetConnectorRequest } from "../models/getconnectorop.js";
import { GetConnectorProjectConnectionRequest } from "../models/getconnectorprojectconnectionop.js";
import { ListConnectorProjectConnectionsRequest } from "../models/listconnectorprojectconnectionsop.js";
import { ListConnectorsRequest } from "../models/listconnectorsop.js";
import { ListProjectConnectorConnectionsRequest } from "../models/listprojectconnectorconnectionsop.js";
import { ReplaceConnectorTriggerDestinationsRequest } from "../models/replaceconnectortriggerdestinationsop.js";
import { UpdateConnectorRequest } from "../models/updateconnectorop.js";
import { UpsertConnectorProjectConnectionRequest } from "../models/upsertconnectorprojectconnectionop.js";
export declare class Connect extends ClientSDK {
/**
* List connectors
*
* @remarks
* List connectors that belong to a team.
*/
listConnectors(request: ListConnectorsRequest, options?: RequestOptions): Promise<ConnectConnectorList>;
/**
* Get a connector
*
* @remarks
* Get the connector by ID. Accepts a dashboard/team requester or a deployment's project OIDC token; project requesters may only read connectors linked to their project and environment.
*/
getConnector(request: GetConnectorRequest, options?: RequestOptions): Promise<ConnectConnector>;
/**
* Delete a connector
*
* @remarks
* Delete a connector, its project connections, and its installation records.
*/
deleteConnector(request: DeleteConnectorRequest, options?: RequestOptions): Promise<void>;
/**
* Create a connector
*
* @remarks
* Create a connector and optionally link it to a project. Use `type` with complete provider data, or use `service` with `connectionMethod` so Connect can supply the type, endpoints, templates, and defaults.
*/
createConnector(request: CreateConnectorRequest, options?: RequestOptions): Promise<ConnectConnectorCreateResult>;
/**
* Update a connector
*
* @remarks
* Update a connector and return the connector with any service-side update signals that the caller must handle.
*/
updateConnector(request: UpdateConnectorRequest, options?: RequestOptions): Promise<ConnectConnectorUpdateResult>;
/**
* Update connector trigger destinations
*
* @remarks
* Replace the full set of destinations that receive trigger requests for a connector.
*/
replaceConnectorTriggerDestinations(request: ReplaceConnectorTriggerDestinationsRequest, options?: RequestOptions): Promise<ConnectConnector>;
/**
* List projects for a connector
*
* @remarks
* List the projects connected to a connector and the environments where each connection is available.
*/
listConnectorProjectConnections(request: ListConnectorProjectConnectionsRequest, options?: RequestOptions): Promise<ConnectConnectorProjectConnectionList>;
/**
* Get a connector project connection
*
* @remarks
* Get the configuration that connects a connector to a project.
*/
getConnectorProjectConnection(request: GetConnectorProjectConnectionRequest, options?: RequestOptions): Promise<ConnectProjectConnection>;
/**
* Create or update a connector project connection
*
* @remarks
* Connect a connector to a project, or replace the environments on an existing project connection.
*/
upsertConnectorProjectConnection(request: UpsertConnectorProjectConnectionRequest, options?: RequestOptions): Promise<ConnectProjectConnection>;
/**
* Disconnect a connector from a project
*
* @remarks
* Disconnect a connector from a project.
*/
deleteConnectorProjectConnection(request: DeleteConnectorProjectConnectionRequest, options?: RequestOptions): Promise<void>;
/**
* List connectors for a project
*
* @remarks
* List the connectors connected to a project and the environments where each connection is available.
*/
listProjectConnectorConnections(request: ListProjectConnectorConnectionsRequest, options?: RequestOptions): Promise<ConnectProjectConnectorConnectionList>;
}
//# sourceMappingURL=connect.d.ts.map