Class FtpApi

Hierarchy

BaseAPI
BaseAPI
- FtpApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FtpApi(configuration: Configuration): FtpApi

Overrides BaseAPI.constructor
- Defined in encoding/inputs/ftp/FtpApi.ts:16
Parameters
- configuration: Configuration
Returns FtpApi

Properties

customdata

customdata: CustomdataApi

Protected restClient

restClient: RestClient

Methods

create

create(ftpInput: FtpInput): Promise<FtpInput>

- Defined in encoding/inputs/ftp/FtpApi.ts:29
Parameters
- Optional ftpInput: FtpInput
Returns Promise<FtpInput>

delete

delete(inputId: string): Promise<FtpInput>

- Defined in encoding/inputs/ftp/FtpApi.ts:41
Parameters
- inputId: string
Returns Promise<FtpInput>

get

get(inputId: string): Promise<FtpInput>

- Defined in encoding/inputs/ftp/FtpApi.ts:56
Parameters
- inputId: string
Returns Promise<FtpInput>

list

list(queryParameters: FtpInputListQueryParams | function): Promise<PaginationResponse<FtpInput>>

- Defined in encoding/inputs/ftp/FtpApi.ts:71
Parameters
- Optional queryParameters: FtpInputListQueryParams | function
Returns Promise<PaginationResponse<FtpInput>>

Generated using TypeDoc