Class SpaceStorageClient

Space storage client.

Hierarchy (View Summary)

ChatBotKitClient
- SpaceStorageClient

Index

Constructors

Methods

copy delete download extend list move upload

Constructors

constructor

new SpaceStorageClient(options: ChatBotKitClientOptions): SpaceStorageClient
Parameters
- options: ChatBotKitClientOptions
Returns SpaceStorageClient
Overrides ChatBotKitClient.constructor
- Defined in space/storage/index.js:24

Methods

copy

copy(spaceId: string, path: string, request: {}): Promise<{}>
Copies a file in space storage.
Parameters
- spaceId: string
- path: string
- request: {}
Returns Promise<{}>
- Defined in space/storage/index.js:84

delete

delete(spaceId: string, path: string, request?: {}): Promise<{}>
Deletes a file or directory from space storage.
Parameters
- spaceId: string
- path: string
- Optionalrequest: {}
Returns Promise<{}>
- Defined in space/storage/index.js:72

download

download(
    spaceId: string,
    path: string,
    request?: never,
): ResponsePromise<{}, never>
Gets a presigned download URL for a file.
Parameters
- spaceId: string
- path: string
- Optionalrequest: never
Returns ResponsePromise<{}, never>
- Defined in space/storage/index.js:48

extend

extend(extensionOptions: Partial<ChatBotKitClientOptions>): SpaceStorageClient
Creates a new instance of the same client type with extended options.

This is useful when you need to create a client with modified configuration (e.g., different endpoint, token, or headers) without affecting the original.

Note: This method creates a completely new instance rather than cloning, which is necessary because private class fields cannot be copied.
Parameters
- extensionOptions: Partial<ChatBotKitClientOptions>
  Options to merge with current options
Returns SpaceStorageClient
A new instance of the same client class with extended options
Inherited from ChatBotKitClient.extend
- Defined in client.js:390

list

list(spaceId: string, path?: string, request?: {}): ResponsePromise<{}, never>
Lists files and directories in space storage.
Parameters
- spaceId: string
- Optionalpath: string
- Optionalrequest: {}
Returns ResponsePromise<{}, never>
- Defined in space/storage/index.js:36

move

move(spaceId: string, path: string, request: {}): Promise<{}>
Moves (renames) a file in space storage.
Parameters
- spaceId: string
- path: string
- request: {}
Returns Promise<{}>
- Defined in space/storage/index.js:96

upload

upload(spaceId: string, path: string, request: {} | {}): Promise<{}>
Uploads a file to space storage.
Parameters
- spaceId: string
- path: string
- request: {} | {}
Returns Promise<{}>
- Defined in space/storage/index.js:60