Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InvitesApi

Hierarchy

  • InvitesApi

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

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

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

invitesJsonPost

  • invitesJsonPost(apiKey: string, apiUsername: string, inlineObject7?: InlineObject7, options?: { headers: {} }): Promise<{ body: InlineResponse20013; response: IncomingMessage }>
  • summary

    Create an invite

    Parameters

    • apiKey: string
    • apiUsername: string
    • Optional inlineObject7: InlineObject7
    • Default value options: { headers: {} } = {headers: {}}
      • headers: {}
        • [name: string]: string

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

setApiKey

setDefaultAuthentication

tIdInviteJsonPost

  • tIdInviteJsonPost(apiKey: string, apiUsername: string, id: string, inlineObject18?: InlineObject18, options?: { headers: {} }): Promise<{ body: InlineResponse20034; response: IncomingMessage }>
  • summary

    Invite to topic

    Parameters

    • apiKey: string
    • apiUsername: string
    • id: string
    • Optional inlineObject18: InlineObject18
    • Default value options: { headers: {} } = {headers: {}}
      • headers: {}
        • [name: string]: string

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

Object literals

Protected authentications

authentications: object

default

default: Authentication = <Authentication>new VoidAuth()

Generated using TypeDoc