Class FilesApi

FilesApi - object-oriented interface export FilesApi

Hierarchy (view full)

BaseAPI
- FilesApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

new FilesApi(configuration?, basePath?, axios?): FilesApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns FilesApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

payoutsUpload

payoutsUpload(paymentCycleId?, fileType?, file?, options?): Promise<AxiosResponse<PaymentCycleFile, any>>
summary Upload a file for validationa and store in blob for payouts
Parameters
- OptionalpaymentCycleId: string
  Include the payment cycle ID associated with the uploaded file.
- OptionalfileType: "payouts"
  payment cycle file type. payouts
- Optionalfile: File
  file to upload.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaymentCycleFile, any>>
Throws
memberof FilesApi
- Defined in src/api/api.ts:16525