Function AssetsApiFactory

  • AssetsApi - factory interface

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        assetsCreate(requestParameters?, options?) => AxiosPromise<AssetRead>;
        assetsDestroy(requestParameters, options?) => AxiosPromise<void>;
        assetsRetrieve(requestParameters, options?) => AxiosPromise<void>;
        assetsRetrievePublic(requestParameters, options?) => AxiosPromise<AssetRead>;
    }

    • assetsCreate:function
      • Parameters

        • requestParameters: AssetsApiAssetsCreateRequest = {}

          Request parameters.

        • Optional options: AxiosRequestConfig<any>

          Override http request option.

        Returns AxiosPromise<AssetRead>

        Summary

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

        Throws

    • assetsDestroy:function
      • Parameters

        Returns AxiosPromise<void>

        Summary

        Method deletes a specific asset from the server

        Throws

    • assetsRetrieve:function
      • Parameters

        Returns AxiosPromise<void>

        Summary

        Method returns an asset file

        Throws

    • assetsRetrievePublic:function

    Export

Generated using TypeDoc