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

package main

import(
	"context"
	"os"
	sdkgo "github.com/apideck-libraries/sdk-go"
	"github.com/apideck-libraries/sdk-go/models/components"
	"github.com/apideck-libraries/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("APIDECK_API_KEY")),
        sdkgo.WithConsumerID("test-consumer"),
        sdkgo.WithAppID("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"),
    )

    res, err := s.FileStorage.Files.List(ctx, operations.FileStorageFilesAllRequest{
        ServiceID: sdkgo.String("salesforce"),
        Filter: &components.FilesFilter{
            DriveID: sdkgo.String("1234"),
            FolderID: sdkgo.String("root"),
            Shared: sdkgo.Bool(true),
        },
        Sort: &components.FilesSort{
            By: components.FilesSortByUpdatedAt.ToPointer(),
        },
        PassThrough: map[string]any{
            "search": "San Francisco",
        },
        Fields: sdkgo.String("id,updated_at"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.GetFilesResponse != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.FileStorageFilesAllRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.FileStorageFilesAllResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestResponse	400	application/json
apierrors.UnauthorizedResponse	401	application/json
apierrors.PaymentRequiredResponse	402	application/json
apierrors.NotFoundResponse	404	application/json
apierrors.UnprocessableResponse	422	application/json
apierrors.APIError	4XX, 5XX	/

Search

Search Files

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/apideck-libraries/sdk-go"
	"github.com/apideck-libraries/sdk-go/models/components"
	"github.com/apideck-libraries/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("APIDECK_API_KEY")),
        sdkgo.WithConsumerID("test-consumer"),
        sdkgo.WithAppID("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"),
    )

    res, err := s.FileStorage.Files.Search(ctx, operations.FileStorageFilesSearchRequest{
        ServiceID: sdkgo.String("salesforce"),
        PassThrough: map[string]any{
            "search": "San Francisco",
        },
        Fields: sdkgo.String("id,updated_at"),
        Filter: &components.FilesFilter{
            DriveID: sdkgo.String("1234"),
            FolderID: sdkgo.String("root"),
            Shared: sdkgo.Bool(true),
        },
        FilesSearch: components.FilesSearch{
            Query: "logo jpg",
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.GetFilesResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.FileStorageFilesSearchRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.FileStorageFilesSearchResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestResponse	400	application/json
apierrors.UnauthorizedResponse	401	application/json
apierrors.PaymentRequiredResponse	402	application/json
apierrors.NotFoundResponse	404	application/json
apierrors.UnprocessableResponse	422	application/json
apierrors.APIError	4XX, 5XX	/

Get

Get File

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/apideck-libraries/sdk-go"
	"github.com/apideck-libraries/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("APIDECK_API_KEY")),
        sdkgo.WithConsumerID("test-consumer"),
        sdkgo.WithAppID("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"),
    )

    res, err := s.FileStorage.Files.Get(ctx, operations.FileStorageFilesOneRequest{
        ID: "<id>",
        ServiceID: sdkgo.String("salesforce"),
        Fields: sdkgo.String("id,updated_at"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.GetFileResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.FileStorageFilesOneRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.FileStorageFilesOneResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestResponse	400	application/json
apierrors.UnauthorizedResponse	401	application/json
apierrors.PaymentRequiredResponse	402	application/json
apierrors.NotFoundResponse	404	application/json
apierrors.UnprocessableResponse	422	application/json
apierrors.APIError	4XX, 5XX	/

Update

Rename or move File

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/apideck-libraries/sdk-go"
	"github.com/apideck-libraries/sdk-go/models/components"
	"github.com/apideck-libraries/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("APIDECK_API_KEY")),
        sdkgo.WithConsumerID("test-consumer"),
        sdkgo.WithAppID("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"),
    )

    res, err := s.FileStorage.Files.Update(ctx, operations.FileStorageFilesUpdateRequest{
        ID: "<id>",
        ServiceID: sdkgo.String("salesforce"),
        UpdateFileRequest: components.UpdateFileRequest{
            Name: sdkgo.String("New Name.pdf"),
            Description: sdkgo.String("Renamed PDF Document"),
            ParentFolderID: sdkgo.String("1234"),
            PassThrough: []components.PassThroughBody{
                components.PassThroughBody{
                    ServiceID: "<id>",
                    ExtendPaths: []components.ExtendPaths{
                        components.ExtendPaths{
                            Path: "$.nested.property",
                            Value: map[string]any{
                                "TaxClassificationRef": map[string]any{
                                    "value": "EUC-99990201-V1-00020000",
                                },
                            },
                        },
                        components.ExtendPaths{
                            Path: "$.nested.property",
                            Value: map[string]any{
                                "TaxClassificationRef": map[string]any{
                                    "value": "EUC-99990201-V1-00020000",
                                },
                            },
                        },
                    },
                },
                components.PassThroughBody{
                    ServiceID: "<id>",
                    ExtendPaths: []components.ExtendPaths{
                        components.ExtendPaths{
                            Path: "$.nested.property",
                            Value: map[string]any{
                                "TaxClassificationRef": map[string]any{
                                    "value": "EUC-99990201-V1-00020000",
                                },
                            },
                        },
                        components.ExtendPaths{
                            Path: "$.nested.property",
                            Value: map[string]any{
                                "TaxClassificationRef": map[string]any{
                                    "value": "EUC-99990201-V1-00020000",
                                },
                            },
                        },
                    },
                },
                components.PassThroughBody{
                    ServiceID: "<id>",
                    ExtendPaths: []components.ExtendPaths{
                        components.ExtendPaths{
                            Path: "$.nested.property",
                            Value: map[string]any{
                                "TaxClassificationRef": map[string]any{
                                    "value": "EUC-99990201-V1-00020000",
                                },
                            },
                        },
                        components.ExtendPaths{
                            Path: "$.nested.property",
                            Value: map[string]any{
                                "TaxClassificationRef": map[string]any{
                                    "value": "EUC-99990201-V1-00020000",
                                },
                            },
                        },
                        components.ExtendPaths{
                            Path: "$.nested.property",
                            Value: map[string]any{
                                "TaxClassificationRef": map[string]any{
                                    "value": "EUC-99990201-V1-00020000",
                                },
                            },
                        },
                    },
                },
            },
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.UpdateFileResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.FileStorageFilesUpdateRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.FileStorageFilesUpdateResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestResponse	400	application/json
apierrors.UnauthorizedResponse	401	application/json
apierrors.PaymentRequiredResponse	402	application/json
apierrors.NotFoundResponse	404	application/json
apierrors.UnprocessableResponse	422	application/json
apierrors.APIError	4XX, 5XX	/

Delete

Delete File

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/apideck-libraries/sdk-go"
	"github.com/apideck-libraries/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("APIDECK_API_KEY")),
        sdkgo.WithConsumerID("test-consumer"),
        sdkgo.WithAppID("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"),
    )

    res, err := s.FileStorage.Files.Delete(ctx, operations.FileStorageFilesDeleteRequest{
        ID: "<id>",
        ServiceID: sdkgo.String("salesforce"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.DeleteFileResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.FileStorageFilesDeleteRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.FileStorageFilesDeleteResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestResponse	400	application/json
apierrors.UnauthorizedResponse	401	application/json
apierrors.PaymentRequiredResponse	402	application/json
apierrors.NotFoundResponse	404	application/json
apierrors.UnprocessableResponse	422	application/json
apierrors.APIError	4XX, 5XX	/

Download

Download File

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/apideck-libraries/sdk-go"
	"github.com/apideck-libraries/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("APIDECK_API_KEY")),
        sdkgo.WithConsumerID("test-consumer"),
        sdkgo.WithAppID("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"),
    )

    res, err := s.FileStorage.Files.Download(ctx, operations.FileStorageFilesDownloadRequest{
        ID: "<id>",
        ServiceID: sdkgo.String("salesforce"),
        Fields: sdkgo.String("id,updated_at"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.GetFileDownloadResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.FileStorageFilesDownloadRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.FileStorageFilesDownloadResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestResponse	400	application/json
apierrors.UnauthorizedResponse	401	application/json
apierrors.PaymentRequiredResponse	402	application/json
apierrors.NotFoundResponse	404	application/json
apierrors.UnprocessableResponse	422	application/json
apierrors.APIError	4XX, 5XX	/

Export

Export File

Example Usage

package main

import(
	"context"
	"os"
	sdkgo "github.com/apideck-libraries/sdk-go"
	"github.com/apideck-libraries/sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := sdkgo.New(
        sdkgo.WithSecurity(os.Getenv("APIDECK_API_KEY")),
        sdkgo.WithConsumerID("test-consumer"),
        sdkgo.WithAppID("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"),
    )

    res, err := s.FileStorage.Files.Export(ctx, operations.FileStorageFilesExportRequest{
        ID: "<id>",
        ServiceID: sdkgo.String("salesforce"),
        Fields: sdkgo.String("id,updated_at"),
        Format: "pdf",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.GetFileDownloadResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`request`	operations.FileStorageFilesExportRequest	✔️	The request object to use for the request.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.FileStorageFilesExportResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestResponse	400	application/json
apierrors.UnauthorizedResponse	401	application/json
apierrors.PaymentRequiredResponse	402	application/json
apierrors.NotFoundResponse	404	application/json
apierrors.UnprocessableResponse	422	application/json
apierrors.APIError	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