AdminApi | @balena/discourse-sdk

Hierarchy

AdminApi

Index

Constructors

constructor

Properties

Accessors

Methods

Object literals

authentications

Constructors

constructor

new AdminApi(basePath?: undefined | string): AdminApi

- Defined in lib/api/adminApi.ts:49
Parameters
- Optional basePath: undefined | string
Returns AdminApi

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

- Defined in lib/api/adminApi.ts:80
Returns string
- Defined in lib/api/adminApi.ts:68
Parameters
- basePath: string
Returns void

defaultHeaders

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

- Defined in lib/api/adminApi.ts:76
Returns any
- Defined in lib/api/adminApi.ts:72
Parameters
- defaultHeaders: any
Returns void

useQuerystring

set useQuerystring(value: boolean): void

- Defined in lib/api/adminApi.ts:64
Parameters
- value: boolean
Returns void

Methods

addInterceptor

addInterceptor(interceptor: Interceptor): void

- Defined in lib/api/adminApi.ts:92
Parameters
- interceptor: Interceptor
Returns void

adminUsersIdJsonDelete

adminUsersIdJsonDelete(id: number, inlineObject27?: InlineObject27, options?: { headers: {} }): Promise<{ body: InlineResponse20044; response: IncomingMessage }>

- Defined in lib/api/adminApi.ts:102
summary

Delete a user

Parameters
- id: number
- Optional inlineObject27: InlineObject27
- Default value options: { headers: {} } = {headers: {}}
  - headers: {}
    - [name: string]: string
Returns Promise<{ body: InlineResponse20044; response: IncomingMessage }>

adminUsersIdJsonGet

adminUsersIdJsonGet(id: number, options?: { headers: {} }): Promise<{ body: InlineResponse20043; response: IncomingMessage }>

- Defined in lib/api/adminApi.ts:172
summary

Get a user by id

Parameters
- id: number
- Default value options: { headers: {} } = {headers: {}}
  - headers: {}
    - [name: string]: string
Returns Promise<{ body: InlineResponse20043; response: IncomingMessage }>

adminUsersIdLogOutJsonPost

adminUsersIdLogOutJsonPost(id: number, options?: { headers: {} }): Promise<{ body: InlineResponse2001; response: IncomingMessage }>

- Defined in lib/api/adminApi.ts:241
summary

Log a user out

Parameters
- id: number
- Default value options: { headers: {} } = {headers: {}}
  - headers: {}
    - [name: string]: string
Returns Promise<{ body: InlineResponse2001; response: IncomingMessage }>

adminUsersIdSuspendJsonPut

adminUsersIdSuspendJsonPut(id: number, inlineObject28?: InlineObject28, options?: { headers: {} }): Promise<{ body: InlineResponse20045; response: IncomingMessage }>

- Defined in lib/api/adminApi.ts:311
summary

Suspend a user

Parameters
- id: number
- Optional inlineObject28: InlineObject28
- Default value options: { headers: {} } = {headers: {}}
  - headers: {}
    - [name: string]: string
Returns Promise<{ body: InlineResponse20045; response: IncomingMessage }>

adminUsersListFlagJsonGet

adminUsersListFlagJsonGet(flag: "active" | "new" | "staff" | "suspended" | "blocked" | "suspect", order?: "created" | "last_emailed" | "seen" | "username" | "email" | "trust_level" | "days_visited" | "posts_read" | "topics_viewed" | "posts" | "read_time", asc?: undefined | "true", page?: undefined | number, showEmails?: undefined | false | true, options?: { headers: {} }): Promise<{ body: Set<InlineResponse20047>; response: IncomingMessage }>

- Defined in lib/api/adminApi.ts:385
summary

Get a list of users

Parameters
- flag: "active" | "new" | "staff" | "suspended" | "blocked" | "suspect"
- Optional order: "created" | "last_emailed" | "seen" | "username" | "email" | "trust_level" | "days_visited" | "posts_read" | "topics_viewed" | "posts" | "read_time"
- Optional asc: undefined | "true"
- Optional page: undefined | number
- Optional showEmails: undefined | false | true
- Default value options: { headers: {} } = {headers: {}}
  - headers: {}
    - [name: string]: string
Returns Promise<{ body: Set<InlineResponse20047>; response: IncomingMessage }>

setApiKey

setApiKey(key: AdminApiApiKeys, value: string): void

- Defined in lib/api/adminApi.ts:88
Parameters
- key: AdminApiApiKeys
- value: string
Returns void

setDefaultAuthentication

setDefaultAuthentication(auth: Authentication): void

- Defined in lib/api/adminApi.ts:84
Parameters
- auth: Authentication
Returns void

userAvatarUsernameRefreshGravatarJsonPost

userAvatarUsernameRefreshGravatarJsonPost(username: string, options?: { headers: {} }): Promise<{ body: InlineResponse20046; response: IncomingMessage }>

- Defined in lib/api/adminApi.ts:470
summary

Refresh gravatar

Parameters
- username: string
- Default value options: { headers: {} } = {headers: {}}
  - headers: {}
    - [name: string]: string
Returns Promise<{ body: InlineResponse20046; response: IncomingMessage }>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Parameters

Optional basePath: undefined | string

Returns AdminApi

Properties

Protected _basePath

Protected _defaultHeaders

Protected _useQuerystring

Protected interceptors

Accessors

basePath

Returns string

Parameters

basePath: string

Returns void

defaultHeaders

Returns any

Parameters

defaultHeaders: any

Returns void

useQuerystring

Parameters

value: boolean

Returns void

Methods

addInterceptor

Parameters

interceptor: Interceptor

Returns void

adminUsersIdJsonDelete

Parameters

id: number

Optional inlineObject27: InlineObject27

Default value options: { headers: {} } = {headers: {}}

headers: {}

[name: string]: string

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

adminUsersIdJsonGet

Parameters

id: number

Default value options: { headers: {} } = {headers: {}}

headers: {}

[name: string]: string

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

adminUsersIdLogOutJsonPost

Parameters

id: number

Default value options: { headers: {} } = {headers: {}}

headers: {}

[name: string]: string

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

adminUsersIdSuspendJsonPut

Parameters

id: number

Optional inlineObject28: InlineObject28

Default value options: { headers: {} } = {headers: {}}

headers: {}

[name: string]: string

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

adminUsersListFlagJsonGet

Parameters

flag: "active" | "new" | "staff" | "suspended" | "blocked" | "suspect"

Optional order: "created" | "last_emailed" | "seen" | "username" | "email" | "trust_level" | "days_visited" | "posts_read" | "topics_viewed" | "posts" | "read_time"

Optional asc: undefined | "true"

Optional page: undefined | number

Optional showEmails: undefined | false | true

Default value options: { headers: {} } = {headers: {}}

headers: {}

[name: string]: string

Returns Promise<{ body: Set<InlineResponse20047>; response: IncomingMessage }>

setApiKey

Parameters