Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ImagesApi

ImagesApi - object-oriented interface

export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • Default value basePath: string = BASE_PATH
    • Default value axios: AxiosInstance = globalAxios

    Returns ImagesApi

Properties

Protected axios

axios: AxiosInstance

Protected basePath

basePath: string

Protected configuration

configuration: Configuration | undefined

Methods

getImage

  • getImage(title: string, options?: any): Promise<AxiosResponse<any>>
  • summary

    Retrieves a user uploaded image for use in a template

    throws

    {RequiredError}

    memberof

    ImagesApi

    Parameters

    • title: string
    • Optional options: any

    Returns Promise<AxiosResponse<any>>

uploadImage

  • Uploads an image to the server for use in templates

    summary

    Upload an image for use in a template

    throws

    {RequiredError}

    memberof

    ImagesApi

    Parameters

    • Optional image: any
    • Optional options: any

    Returns Promise<AxiosResponse<InlineResponse2001>>

Generated using TypeDoc