Skip to content

Latest commit

 

History

History
322 lines (242 loc) · 17 KB

README.md

File metadata and controls

322 lines (242 loc) · 17 KB
Raw

Storage

(Storage)

Overview

Available Operations

CreateStorageFile

Create a file

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.CreateStorageFileRequest{
        ConnectionID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Storage.CreateStorageFile(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.StorageFile != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.CreateStorageFileResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

GetStorageFile

Retrieve a file

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.GetStorageFileRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Storage.GetStorageFile(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.StorageFile != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.GetStorageFileResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

ListStorageFiles

List all files

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.ListStorageFilesRequest{
        ConnectionID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Storage.ListStorageFiles(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.StorageFiles != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.ListStorageFilesResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

PatchStorageFile

Update a file

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.PatchStorageFileRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Storage.PatchStorageFile(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.StorageFile != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.PatchStorageFileResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

RemoveStorageFile

Remove a file

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.RemoveStorageFileRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Storage.RemoveStorageFile(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.RemoveStorageFileResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

UpdateStorageFile

Update a file

Example Usage

package main

import(
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New()
    request := operations.UpdateStorageFileRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Storage.UpdateStorageFile(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.StorageFile != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.UpdateStorageFileResponse, error

Errors

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /