Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 | 11x 11x 11x 11x 11x 11x 11x 27x 27x 27x 1x 1x 1x 1x 1x 1x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 26x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | import { z } from "zod";
import { Client } from "@hey-api/client-axios";
import {
DeleteRowAPIDTO,
ExpectedInputFieldsDTO,
GetConnectorInfoResDTO,
GetConnectorListResDTO,
} from "../client";
import apiClient from "../client/client";
import {
ZAuthMode,
ZCreateIntegrationParams,
ZListIntegrationsParams,
ZSingleIntegrationParams,
} from "../types/integration";
import { CEG } from "../utils/error";
import { COMPOSIO_SDK_ERROR_CODES } from "../utils/errors/src/constants";
import { TELEMETRY_LOGGER } from "../utils/telemetry";
import { TELEMETRY_EVENTS } from "../utils/telemetry/events";
import { AxiosBackendClient } from "./backendClient";
// Types generated from zod schemas
export type IntegrationGetRequiredParam = z.infer<
typeof ZSingleIntegrationParams
>;
export type IntegrationCreateParams = z.infer<
typeof ZCreateIntegrationParams
> & {
/** @deprecated use appUniqueKey field instead */
appId?: string;
};
export type IntegrationListParam = z.infer<typeof ZListIntegrationsParams> & {
/** @deprecated use appUniqueKeys field instead */
appName?: string;
};
type IntegrationDeleteParam = z.infer<typeof ZSingleIntegrationParams>;
// API response types
export type IntegrationCreateData = {
requestBody?: IntegrationCreateParams;
};
export type IntegrationListRes = GetConnectorListResDTO;
export type IntegrationGetRes = GetConnectorInfoResDTO;
export type IntegrationRequiredParamsRes = ExpectedInputFieldsDTO[];
export type IntegrationDeleteRes = DeleteRowAPIDTO;
export class Integrations {
private backendClient: AxiosBackendClient;
private fileName: string = "js/src/sdk/models/integrations.ts";
private client: Client;
constructor(backendClient: AxiosBackendClient, client: Client) {
this.backendClient = backendClient;
this.client = client;
}
/**
* Retrieves a list of all available integrations in the Composio platform.
*
* This method allows clients to explore and discover the supported integrations. It returns an array of integration objects, each containing essential details such as the integration's key, name, description, logo, categories, and unique identifier.
*
* @returns {Promise<IntegrationListRes>} A promise that resolves to the list of all integrations.
* @throws {ComposioError} If the request fails.
*/
async list(data: IntegrationListParam = {}): Promise<IntegrationListRes> {
TELEMETRY_LOGGER.manualTelemetry(TELEMETRY_EVENTS.SDK_METHOD_INVOKED, {
method: "list",
file: this.fileName,
params: { data },
});
try {
const { appName, appUniqueKey, ...rest } =
ZListIntegrationsParams.parse(data);
const finalAppName =
appName && appName.length > 0 ? appName : appUniqueKey;
const response = await apiClient.appConnector.listAllConnectors({
client: this.client,
query: { ...rest, appName: finalAppName },
throwOnError: true,
});
return response.data;
} catch (error) {
throw CEG.handleAllError(error);
}
}
/**
* Retrieves details of a specific integration in the Composio platform by providing its integration name.
*
* The response includes the integration's name, display name, description, input parameters, expected response, associated app information, and enabled status.
*
* @param {IntegrationGetParam} data The data for the request.
* @returns {Promise<IntegrationGetResponse>} A promise that resolves to the details of the integration.
* @throws {ComposioError} If the request fails.
*/
async get(data: IntegrationGetRequiredParam): Promise<IntegrationGetRes> {
TELEMETRY_LOGGER.manualTelemetry(TELEMETRY_EVENTS.SDK_METHOD_INVOKED, {
method: "get",
file: this.fileName,
params: { data },
});
try {
const response = await apiClient.appConnector.getConnectorInfo({
client: this.client,
path: data,
throwOnError: true,
});
return response.data;
} catch (error) {
throw CEG.handleAllError(error);
}
}
/**
* Retrieves the required parameters for a specific integration's authentication scheme.
*
* This method is used to get the necessary input fields for a specific integration's authentication scheme.
*
* @param {IntegrationGetParam} data The data for the request.
* @returns {Promise<IntegrationRequiredParamsRes>} A promise that resolves to the required parameters for the integration's authentication scheme.
* @throws {ComposioError} If the request fails.
*/
async getRequiredParams(
data: IntegrationGetRequiredParam
): Promise<IntegrationRequiredParamsRes> {
TELEMETRY_LOGGER.manualTelemetry(TELEMETRY_EVENTS.SDK_METHOD_INVOKED, {
method: "getRequiredParams",
file: this.fileName,
params: { data },
});
try {
ZSingleIntegrationParams.parse(data);
const response = await apiClient.appConnector.getConnectorInfo({
client: this.client,
path: {
integrationId: data.integrationId,
},
throwOnError: true,
});
return response.data?.expectedInputFields;
} catch (error) {
throw CEG.handleAllError(error);
}
}
/**
* Creates a new integration in the Composio platform.
*
* This method allows clients to create a new integration by providing the necessary details such as app ID, name, authentication mode, and configuration.
*
* @param {IntegrationCreateParams} data The data for the request.
* @returns {Promise<IntegrationGetResponse>} A promise that resolves to the created integration model.
* @throws {ComposioError} If the request fails.
*/
async create(data: IntegrationCreateParams): Promise<IntegrationGetRes> {
TELEMETRY_LOGGER.manualTelemetry(TELEMETRY_EVENTS.SDK_METHOD_INVOKED, {
method: "create",
file: this.fileName,
params: { data },
});
try {
ZCreateIntegrationParams.parse(data);
let uniqueKey = data.appUniqueKey;
if (!uniqueKey) {
const apps = await apiClient.apps.getApps({ client: this.client });
const app = apps.data?.items.find((app) => app.appId === data.appId);
uniqueKey = app!.key;
Iif (!uniqueKey) {
throw CEG.getCustomError(
COMPOSIO_SDK_ERROR_CODES.COMMON.INVALID_PARAMS_PASSED,
{
message: `No app was found with the provided appId`,
description: `Please provide an app unique key`,
}
);
}
}
const response = await apiClient.appConnectorV2.createConnectorV2({
client: this.client,
body: {
app: {
uniqueKey: uniqueKey,
},
config: {
useComposioAuth: data.useComposioAuth,
name: data.name,
authScheme: data.authScheme as z.infer<typeof ZAuthMode>,
integrationSecrets: data.authConfig,
},
},
throwOnError: true,
});
const integrationId = response.data.integrationId;
return this.get({ integrationId });
} catch (error) {
throw CEG.handleAllError(error);
}
}
async getOrCreateIntegration(
data: IntegrationCreateParams
): Promise<IntegrationGetRes> {
TELEMETRY_LOGGER.manualTelemetry(TELEMETRY_EVENTS.SDK_METHOD_INVOKED, {
method: "getOrCreateIntegration",
file: this.fileName,
params: { data },
});
try {
ZCreateIntegrationParams.parse(data);
let uniqueKey = data.appUniqueKey;
Iif (!uniqueKey) {
const apps = await apiClient.apps.getApps({ client: this.client });
const app = apps.data?.items.find((app) => app.appId === data.appId);
uniqueKey = app!.key;
throw CEG.getCustomError(
COMPOSIO_SDK_ERROR_CODES.COMMON.INVALID_PARAMS_PASSED,
{
message: `No app was found with the provided appId`,
description: `Please provide an app unique key`,
}
);
}
const response = await apiClient.appConnectorV2.getOrCreateConnector({
client: this.client,
body: {
app: {
uniqueKey,
},
config: {
useComposioAuth: data.useComposioAuth,
name: data.name,
authScheme: data.authScheme as z.infer<typeof ZAuthMode>,
integrationSecrets: data.authConfig,
},
},
throwOnError: true,
});
const integrationId = response.data.integrationId;
return this.get({ integrationId });
} catch (error) {
throw CEG.handleAllError(error);
}
}
/**
* Deletes an existing integration in the Composio platform.
*
* This method allows clients to delete an existing integration by providing its integration ID.
*
* @param {IntegrationListData} data The data for the request.
* @returns {Promise<IntegrationDeleteResponse>} A promise that resolves to the deleted integration model.
* @throws {ComposioError} If the request fails.
*/
async delete(data: IntegrationDeleteParam): Promise<IntegrationDeleteRes> {
TELEMETRY_LOGGER.manualTelemetry(TELEMETRY_EVENTS.SDK_METHOD_INVOKED, {
method: "delete",
file: this.fileName,
params: { data },
});
try {
ZSingleIntegrationParams.parse(data);
const response = await apiClient.appConnector.deleteConnector({
client: this.client,
path: {
integrationId: data.integrationId,
},
throwOnError: true,
});
return response.data;
} catch (error) {
throw CEG.handleAllError(error);
}
}
}
|