Class FtpEndpoint

Hierarchy

FtpEndpoint

Index

Constructors

constructor

Properties

client

Methods

Constructors

constructor

new FtpEndpoint(client: BegetRequest): FtpEndpoint

- Defined in src/endpoints/ftp.ts:5
Parameters
- client: BegetRequest
Returns FtpEndpoint

Properties

Private Readonly client

client: BegetRequest

Methods

add

add(params: AddAccount): Promise<boolean>

- Defined in src/endpoints/ftp.ts:26
Method adds new FTP account.

Parameters
- params: AddAccount
Returns Promise<boolean>

Returns property of successful or unsuccessful execution.

changePassword

changePassword(params: Pick<Account, "suffix" | "password">): Promise<boolean>

- Defined in src/endpoints/ftp.ts:34
Method performs password change for additional FTP account.

Parameters
- params: Pick<Account, "suffix" | "password">
Returns Promise<boolean>

Returns property of successful or unsuccessful execution.

delete

delete(params: Pick<Account, "suffix">): Promise<boolean>

- Defined in src/endpoints/ftp.ts:42
Method deletes additional FTP account with given suffix.

Parameters
- params: Pick<Account, "suffix">
Returns Promise<boolean>

Returns property of successful or unsuccessful execution.

getList

getList(): Promise<Account[]>

- Defined in src/endpoints/ftp.ts:18
Method returns list of additional FTP accounts with their home directories.

Returns Promise<Account[]>

Private method

method<T>(method: Methods["ftp"], data?: object): Promise<T>

- Defined in src/endpoints/ftp.ts:11
Type parameters
- T
Parameters
- method: Methods["ftp"]
- Optional data: object
Returns Promise<T>

Generated using TypeDoc