Skip to content

Latest commit

 

History

History
235 lines (172 loc) · 9.5 KB

README.md

File metadata and controls

235 lines (172 loc) · 9.5 KB
Raw

Files

(Files)

Overview

Methods related to Files

Available Operations

Delete

Delete file

Example Usage

package main

import(
	"github.com/writerai/writer-client-sdk-go/pkg/models/shared"
	writerclientsdkgo "github.com/writerai/writer-client-sdk-go"
	"context"
	"log"
)

func main() {
    s := writerclientsdkgo.New(
        writerclientsdkgo.WithSecurity("<YOUR_API_KEY_HERE>"),
        writerclientsdkgo.WithOrganizationID(545907),
    )


    var fileID string = "<value>"

    var organizationID *int64 = writerclientsdkgo.Int64(841399)

    ctx := context.Background()
    res, err := s.Files.Delete(ctx, fileID, organizationID)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
fileID string ✔️ N/A
organizationID *int64 ➖ N/A

Response

*operations.DeleteFileResponse, error

Error Object Status Code Content Type
sdkerrors.FailResponse 400,401,403,404,500 application/json
sdkerrors.SDKError 4xx-5xx /

Get

Get file

Example Usage

package main

import(
	"github.com/writerai/writer-client-sdk-go/pkg/models/shared"
	writerclientsdkgo "github.com/writerai/writer-client-sdk-go"
	"context"
	"log"
)

func main() {
    s := writerclientsdkgo.New(
        writerclientsdkgo.WithSecurity("<YOUR_API_KEY_HERE>"),
        writerclientsdkgo.WithOrganizationID(700347),
    )


    var fileID string = "<value>"

    var organizationID *int64 = writerclientsdkgo.Int64(90065)

    ctx := context.Background()
    res, err := s.Files.Get(ctx, fileID, organizationID)
    if err != nil {
        log.Fatal(err)
    }
    if res.ModelFile != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
fileID string ✔️ N/A
organizationID *int64 ➖ N/A

Response

*operations.GetFileResponse, error

Error Object Status Code Content Type
sdkerrors.FailResponse 400,401,403,404,500 application/json
sdkerrors.SDKError 4xx-5xx /

List

List files

Example Usage

package main

import(
	"github.com/writerai/writer-client-sdk-go/pkg/models/shared"
	writerclientsdkgo "github.com/writerai/writer-client-sdk-go"
	"context"
	"log"
)

func main() {
    s := writerclientsdkgo.New(
        writerclientsdkgo.WithSecurity("<YOUR_API_KEY_HERE>"),
        writerclientsdkgo.WithOrganizationID(768578),
    )


    var organizationID *int64 = writerclientsdkgo.Int64(99895)

    ctx := context.Background()
    res, err := s.Files.List(ctx, organizationID)
    if err != nil {
        log.Fatal(err)
    }
    if res.ModelFilesResponse != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
organizationID *int64 ➖ N/A

Response

*operations.ListFilesResponse, error

Error Object Status Code Content Type
sdkerrors.FailResponse 400,401,403,404,500 application/json
sdkerrors.SDKError 4xx-5xx /

Upload

Upload file

Example Usage

package main

import(
	"github.com/writerai/writer-client-sdk-go/pkg/models/shared"
	writerclientsdkgo "github.com/writerai/writer-client-sdk-go"
	"context"
	"log"
)

func main() {
    s := writerclientsdkgo.New(
        writerclientsdkgo.WithSecurity("<YOUR_API_KEY_HERE>"),
        writerclientsdkgo.WithOrganizationID(403654),
    )


    uploadModelFileRequest := shared.UploadModelFileRequest{
        File: shared.File{
            Content: []byte("0x7cbca97eC6"),
            FileName: "plastic_cli.gif",
        },
    }

    var organizationID *int64 = writerclientsdkgo.Int64(360896)

    ctx := context.Background()
    res, err := s.Files.Upload(ctx, uploadModelFileRequest, organizationID)
    if err != nil {
        log.Fatal(err)
    }
    if res.ModelFile != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
uploadModelFileRequest shared.UploadModelFileRequest ✔️ N/A
organizationID *int64 ➖ N/A

Response

*operations.UploadFileResponse, error

Error Object Status Code Content Type
sdkerrors.FailResponse 400,401,403,404,500 application/json
sdkerrors.SDKError 4xx-5xx /