Files

(FileStorage.Files)

Overview

Available Operations

List - List Files
Search - Search Files
Get - Get File
Update - Rename or move File
Delete - Delete File
Download - Download File
Export - Export File

List

List Files

Example Usage

using ApideckUnifySdk;
using ApideckUnifySdk.Models.Components;
using ApideckUnifySdk.Models.Requests;
using System.Collections.Generic;

var sdk = new Apideck(
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
    consumerId: "test-consumer",
    appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"
);

FileStorageFilesAllRequest req = new FileStorageFilesAllRequest() {
    ServiceId = "salesforce",
    Filter = new FilesFilter() {
        DriveId = "1234",
        FolderId = "root",
        Shared = true,
    },
    Sort = new FilesSort() {
        By = FilesSortBy.UpdatedAt,
        Direction = SortDirection.Desc,
    },
    PassThrough = new Dictionary<string, object>() {
        { "search", "San Francisco" },
    },
    Fields = "id,updated_at",
};

FileStorageFilesAllResponse? res = await sdk.FileStorage.Files.ListAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

Parameters

Parameter	Type	Required	Description
`request`	FileStorageFilesAllRequest	✔️	The request object to use for the request.

Response

FileStorageFilesAllResponse

Errors

Error Type	Status Code	Content Type
ApideckUnifySdk.Models.Errors.BadRequestResponse	400	application/json
ApideckUnifySdk.Models.Errors.UnauthorizedResponse	401	application/json
ApideckUnifySdk.Models.Errors.PaymentRequiredResponse	402	application/json
ApideckUnifySdk.Models.Errors.NotFoundResponse	404	application/json
ApideckUnifySdk.Models.Errors.UnprocessableResponse	422	application/json
ApideckUnifySdk.Models.Errors.APIException	4XX, 5XX	/

Search

Search Files

Example Usage

using ApideckUnifySdk;
using ApideckUnifySdk.Models.Components;
using ApideckUnifySdk.Models.Requests;
using System.Collections.Generic;

var sdk = new Apideck(
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
    consumerId: "test-consumer",
    appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"
);

FileStorageFilesSearchRequest req = new FileStorageFilesSearchRequest() {
    FilesSearch = new FilesSearch() {
        Query = "logo jpg",
    },
    ServiceId = "salesforce",
    PassThrough = new Dictionary<string, object>() {
        { "search", "San Francisco" },
    },
    Fields = "id,updated_at",
    Filter = new FilesFilter() {
        DriveId = "1234",
        FolderId = "root",
        Shared = true,
    },
};

var res = await sdk.FileStorage.Files.SearchAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	FileStorageFilesSearchRequest	✔️	The request object to use for the request.

Response

FileStorageFilesSearchResponse

Errors

Error Type	Status Code	Content Type
ApideckUnifySdk.Models.Errors.BadRequestResponse	400	application/json
ApideckUnifySdk.Models.Errors.UnauthorizedResponse	401	application/json
ApideckUnifySdk.Models.Errors.PaymentRequiredResponse	402	application/json
ApideckUnifySdk.Models.Errors.NotFoundResponse	404	application/json
ApideckUnifySdk.Models.Errors.UnprocessableResponse	422	application/json
ApideckUnifySdk.Models.Errors.APIException	4XX, 5XX	/

Get

Get File

Example Usage

using ApideckUnifySdk;
using ApideckUnifySdk.Models.Components;
using ApideckUnifySdk.Models.Requests;

var sdk = new Apideck(
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
    consumerId: "test-consumer",
    appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"
);

FileStorageFilesOneRequest req = new FileStorageFilesOneRequest() {
    Id = "<id>",
    ServiceId = "salesforce",
    Fields = "id,updated_at",
};

var res = await sdk.FileStorage.Files.GetAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	FileStorageFilesOneRequest	✔️	The request object to use for the request.

Response

FileStorageFilesOneResponse

Errors

Error Type	Status Code	Content Type
ApideckUnifySdk.Models.Errors.BadRequestResponse	400	application/json
ApideckUnifySdk.Models.Errors.UnauthorizedResponse	401	application/json
ApideckUnifySdk.Models.Errors.PaymentRequiredResponse	402	application/json
ApideckUnifySdk.Models.Errors.NotFoundResponse	404	application/json
ApideckUnifySdk.Models.Errors.UnprocessableResponse	422	application/json
ApideckUnifySdk.Models.Errors.APIException	4XX, 5XX	/

Update

Rename or move File

Example Usage

using ApideckUnifySdk;
using ApideckUnifySdk.Models.Components;
using ApideckUnifySdk.Models.Requests;
using System.Collections.Generic;

var sdk = new Apideck(
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
    consumerId: "test-consumer",
    appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"
);

FileStorageFilesUpdateRequest req = new FileStorageFilesUpdateRequest() {
    Id = "<id>",
    UpdateFileRequest = new UpdateFileRequest() {
        Name = "New Name.pdf",
        Description = "Renamed PDF Document",
        ParentFolderId = "1234",
        PassThrough = new List<PassThroughBody>() {
            new PassThroughBody() {
                ServiceId = "<id>",
                ExtendPaths = new List<ExtendPaths>() {
                    new ExtendPaths() {
                        Path = "$.nested.property",
                        Value = new Dictionary<string, object>() {
                            { "TaxClassificationRef", new Dictionary<string, object>() {
                                { "value", "EUC-99990201-V1-00020000" },
                            } },
                        },
                    },
                },
            },
        },
    },
    ServiceId = "salesforce",
};

var res = await sdk.FileStorage.Files.UpdateAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	FileStorageFilesUpdateRequest	✔️	The request object to use for the request.

Response

FileStorageFilesUpdateResponse

Errors

Error Type	Status Code	Content Type
ApideckUnifySdk.Models.Errors.BadRequestResponse	400	application/json
ApideckUnifySdk.Models.Errors.UnauthorizedResponse	401	application/json
ApideckUnifySdk.Models.Errors.PaymentRequiredResponse	402	application/json
ApideckUnifySdk.Models.Errors.NotFoundResponse	404	application/json
ApideckUnifySdk.Models.Errors.UnprocessableResponse	422	application/json
ApideckUnifySdk.Models.Errors.APIException	4XX, 5XX	/

Delete

Delete File

Example Usage

using ApideckUnifySdk;
using ApideckUnifySdk.Models.Components;
using ApideckUnifySdk.Models.Requests;

var sdk = new Apideck(
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
    consumerId: "test-consumer",
    appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"
);

FileStorageFilesDeleteRequest req = new FileStorageFilesDeleteRequest() {
    Id = "<id>",
    ServiceId = "salesforce",
};

var res = await sdk.FileStorage.Files.DeleteAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	FileStorageFilesDeleteRequest	✔️	The request object to use for the request.

Response

FileStorageFilesDeleteResponse

Errors

Error Type	Status Code	Content Type
ApideckUnifySdk.Models.Errors.BadRequestResponse	400	application/json
ApideckUnifySdk.Models.Errors.UnauthorizedResponse	401	application/json
ApideckUnifySdk.Models.Errors.PaymentRequiredResponse	402	application/json
ApideckUnifySdk.Models.Errors.NotFoundResponse	404	application/json
ApideckUnifySdk.Models.Errors.UnprocessableResponse	422	application/json
ApideckUnifySdk.Models.Errors.APIException	4XX, 5XX	/

Download

Download File

Example Usage

using ApideckUnifySdk;
using ApideckUnifySdk.Models.Components;
using ApideckUnifySdk.Models.Requests;

var sdk = new Apideck(
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
    consumerId: "test-consumer",
    appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"
);

FileStorageFilesDownloadRequest req = new FileStorageFilesDownloadRequest() {
    Id = "<id>",
    ServiceId = "salesforce",
    Fields = "id,updated_at",
};

var res = await sdk.FileStorage.Files.DownloadAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	FileStorageFilesDownloadRequest	✔️	The request object to use for the request.

Response

FileStorageFilesDownloadResponse

Errors

Error Type	Status Code	Content Type
ApideckUnifySdk.Models.Errors.BadRequestResponse	400	application/json
ApideckUnifySdk.Models.Errors.UnauthorizedResponse	401	application/json
ApideckUnifySdk.Models.Errors.PaymentRequiredResponse	402	application/json
ApideckUnifySdk.Models.Errors.NotFoundResponse	404	application/json
ApideckUnifySdk.Models.Errors.UnprocessableResponse	422	application/json
ApideckUnifySdk.Models.Errors.APIException	4XX, 5XX	/

Export

Export File

Example Usage

using ApideckUnifySdk;
using ApideckUnifySdk.Models.Components;
using ApideckUnifySdk.Models.Requests;

var sdk = new Apideck(
    apiKey: "<YOUR_BEARER_TOKEN_HERE>",
    consumerId: "test-consumer",
    appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"
);

FileStorageFilesExportRequest req = new FileStorageFilesExportRequest() {
    Id = "<id>",
    Format = "pdf",
    ServiceId = "salesforce",
    Fields = "id,updated_at",
};

var res = await sdk.FileStorage.Files.ExportAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	FileStorageFilesExportRequest	✔️	The request object to use for the request.

Response

FileStorageFilesExportResponse

Errors

Error Type	Status Code	Content Type
ApideckUnifySdk.Models.Errors.BadRequestResponse	400	application/json
ApideckUnifySdk.Models.Errors.UnauthorizedResponse	401	application/json
ApideckUnifySdk.Models.Errors.PaymentRequiredResponse	402	application/json
ApideckUnifySdk.Models.Errors.NotFoundResponse	404	application/json
ApideckUnifySdk.Models.Errors.UnprocessableResponse	422	application/json
ApideckUnifySdk.Models.Errors.APIException	4XX, 5XX	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

Files

Overview

Available Operations

List

Example Usage

Parameters

Response

Errors

Search

Example Usage

Parameters

Response

Errors

Get

Example Usage

Parameters

Response

Errors

Update

Example Usage

Parameters

Response

Errors

Delete

Example Usage

Parameters

Response

Errors

Download

Example Usage

Parameters

Response

Errors

Export

Example Usage

Parameters

Response

Errors