Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UploadsApi

Hierarchy

  • UploadsApi

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

  • new UploadsApi(basePath?: undefined | string): UploadsApi

Properties

Protected _basePath

_basePath: string = defaultBasePath

Protected _defaultHeaders

_defaultHeaders: any

Protected _useQuerystring

_useQuerystring: boolean = false

Protected interceptors

interceptors: Interceptor[] = []

Accessors

basePath

  • get basePath(): string
  • set basePath(basePath: string): void

defaultHeaders

  • get defaultHeaders(): any
  • set defaultHeaders(defaultHeaders: any): void

useQuerystring

  • set useQuerystring(value: boolean): void

Methods

addInterceptor

setApiKey

setDefaultAuthentication

uploadsJsonPost

  • uploadsJsonPost(type: string, userId?: undefined | number, synchronous?: undefined | false | true, file?: RequestFile, options?: { headers: {} }): Promise<{ body: InlineResponse20039; response: IncomingMessage }>
  • summary

    Creates an upload

    Parameters

    • type: string
    • Optional userId: undefined | number

      required if uploading an avatar

    • Optional synchronous: undefined | false | true

      Use this flag to return an id and url

    • Optional file: RequestFile
    • Default value options: { headers: {} } = {headers: {}}
      • headers: {}
        • [name: string]: string

    Returns Promise<{ body: InlineResponse20039; response: IncomingMessage }>

Object literals

Protected authentications

authentications: object

default

default: Authentication = <Authentication>new VoidAuth()

Generated using TypeDoc