Function AssetsApiFp

  • AssetsApi - functional programming interface

    Parameters

    Returns {
        assetsCreate(file?, options?) => Promise<((axios?, basePath?) => AxiosPromise<AssetRead>)>;
        assetsDestroy(uuid, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
        assetsRetrieve(uuid, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
        assetsRetrievePublic(uuid, options?) => Promise<((axios?, basePath?) => AxiosPromise<AssetRead>)>;
    }

    • assetsCreate:function
      • Parameters

        • Optional file: File
        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<AssetRead>)>

        Summary

        Method saves new asset on the server and attaches it to a corresponding guide

        Throws

    • assetsDestroy:function
      • Parameters

        • uuid: string

          A UUID string identifying this asset.

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

        Summary

        Method deletes a specific asset from the server

        Throws

    • assetsRetrieve:function
      • Parameters

        • uuid: string

          A UUID string identifying this asset.

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

        Summary

        Method returns an asset file

        Throws

    • assetsRetrievePublic:function
      • Parameters

        • uuid: string

          A UUID string identifying this asset.

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<AssetRead>)>

        Throws

    Export

Generated using TypeDoc