# ConnectionSettings (*vault.connectionSettings*) ## Overview ### Available Operations * [list](#list) - Get resource settings * [update](#update) - Update settings ## list This endpoint returns custom settings and their defaults required by connection for a given resource. ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.vault.connectionSettings.list({ unifiedApi: "crm", serviceId: "pipedrive", resource: "leads", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { vaultConnectionSettingsList } from "@apideck/sdk/funcs/vaultConnectionSettingsList.js"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await vaultConnectionSettingsList(apideck, { unifiedApi: "crm", serviceId: "pipedrive", resource: "leads", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.VaultConnectionSettingsAllRequest](../../models/operations/vaultconnectionsettingsallrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.VaultConnectionSettingsAllResponse](../../models/operations/vaultconnectionsettingsallresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## update Update default values for a connection's resource settings ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.vault.connectionSettings.update({ serviceId: "pipedrive", unifiedApi: "crm", resource: "leads", connection: { enabled: true, settings: { "instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx", }, metadata: { "account": { "name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a", }, "plan": "enterprise", }, configuration: [ { resource: "leads", defaults: [ { id: "ProductInterest", options: [ { id: "1234", label: "General Channel", options: [ { label: "General Channel", value: 12.5, }, ], }, ], value: 10, }, ], }, ], customMappings: [ { value: "$.root.training.first_aid", }, ], }, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { vaultConnectionSettingsUpdate } from "@apideck/sdk/funcs/vaultConnectionSettingsUpdate.js"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await vaultConnectionSettingsUpdate(apideck, { serviceId: "pipedrive", unifiedApi: "crm", resource: "leads", connection: { enabled: true, settings: { "instance_url": "https://eu28.salesforce.com", "api_key": "12345xxxxxx", }, metadata: { "account": { "name": "My Company", "id": "c01458a5-7276-41ce-bc19-639906b0450a", }, "plan": "enterprise", }, configuration: [ { resource: "leads", defaults: [ { id: "ProductInterest", options: [ { id: "1234", label: "General Channel", options: [ { label: "General Channel", value: "general", }, ], }, ], value: [ 10, ], }, ], }, ], customMappings: [ { value: "$.root.training.first_aid", }, ], }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.VaultConnectionSettingsUpdateRequest](../../models/operations/vaultconnectionsettingsupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.VaultConnectionSettingsUpdateResponse](../../models/operations/vaultconnectionsettingsupdateresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* |