Function FilesApiFactory

FilesApi - factory interface export

  • FilesApiFactory(configuration?, basePath?, axios?): {
        payoutsUpload(paymentCycleId?: string, fileType?: "payouts", file?: File, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleFile>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        payoutsUpload(paymentCycleId?: string, fileType?: "payouts", file?: File, options?: RawAxiosRequestConfig): AxiosPromise<PaymentCycleFile>;
    }

    • payoutsUpload:function
      • payoutsUpload(paymentCycleId?, fileType?, file?, options?): AxiosPromise<PaymentCycleFile>

      • 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 AxiosPromise<PaymentCycleFile>

        Throws

Settings

Member Visibility