# DriveGroups (*fileStorage.driveGroups*) ## Overview ### Available Operations * [list](#list) - List DriveGroups * [create](#create) - Create DriveGroup * [get](#get) - Get DriveGroup * [update](#update) - Update DriveGroup * [delete](#delete) - Delete DriveGroup ## list List DriveGroups ### 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.fileStorage.driveGroups.list({ serviceId: "salesforce", filter: { parentGroupId: "1234", }, passThrough: { "search": "San Francisco", }, fields: "id,updated_at", }); // 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 { fileStorageDriveGroupsList } from "@apideck/sdk/funcs/fileStorageDriveGroupsList.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 fileStorageDriveGroupsList(apideck, { serviceId: "salesforce", filter: { parentGroupId: "1234", }, passThrough: { "search": "San Francisco", }, fields: "id,updated_at", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.FileStorageDriveGroupsAllRequest](../../models/operations/filestoragedrivegroupsallrequest.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.FileStorageDriveGroupsAllResponse](../../models/operations/filestoragedrivegroupsallresponse.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 | \*/\* | ## create Create DriveGroup ### 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.fileStorage.driveGroups.create({ serviceId: "salesforce", driveGroup: { name: "accounting", displayName: "accounting", description: "A description", passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); // 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 { fileStorageDriveGroupsCreate } from "@apideck/sdk/funcs/fileStorageDriveGroupsCreate.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 fileStorageDriveGroupsCreate(apideck, { serviceId: "salesforce", driveGroup: { name: "accounting", displayName: "accounting", description: "A description", passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.FileStorageDriveGroupsAddRequest](../../models/operations/filestoragedrivegroupsaddrequest.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.FileStorageDriveGroupsAddResponse](../../models/operations/filestoragedrivegroupsaddresponse.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 | \*/\* | ## get Get DriveGroup ### 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.fileStorage.driveGroups.get({ id: "", serviceId: "salesforce", fields: "id,updated_at", }); // 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 { fileStorageDriveGroupsGet } from "@apideck/sdk/funcs/fileStorageDriveGroupsGet.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 fileStorageDriveGroupsGet(apideck, { id: "", serviceId: "salesforce", fields: "id,updated_at", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.FileStorageDriveGroupsOneRequest](../../models/operations/filestoragedrivegroupsonerequest.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.FileStorageDriveGroupsOneResponse](../../models/operations/filestoragedrivegroupsoneresponse.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 DriveGroup ### 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.fileStorage.driveGroups.update({ id: "", serviceId: "salesforce", driveGroup: { name: "accounting", displayName: "accounting", description: "A description", passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); // 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 { fileStorageDriveGroupsUpdate } from "@apideck/sdk/funcs/fileStorageDriveGroupsUpdate.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 fileStorageDriveGroupsUpdate(apideck, { id: "", serviceId: "salesforce", driveGroup: { name: "accounting", displayName: "accounting", description: "A description", passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.FileStorageDriveGroupsUpdateRequest](../../models/operations/filestoragedrivegroupsupdaterequest.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.FileStorageDriveGroupsUpdateResponse](../../models/operations/filestoragedrivegroupsupdateresponse.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 | \*/\* | ## delete Delete DriveGroup ### 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.fileStorage.driveGroups.delete({ id: "", serviceId: "salesforce", }); // 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 { fileStorageDriveGroupsDelete } from "@apideck/sdk/funcs/fileStorageDriveGroupsDelete.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 fileStorageDriveGroupsDelete(apideck, { id: "", serviceId: "salesforce", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.FileStorageDriveGroupsDeleteRequest](../../models/operations/filestoragedrivegroupsdeleterequest.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.FileStorageDriveGroupsDeleteResponse](../../models/operations/filestoragedrivegroupsdeleteresponse.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 | \*/\* |