Class BotUsers

Hierarchy

BotUsers

Index

Constructors

constructor

Methods

Constructors

constructor

new BotUsers(httpClient: Wretcher): BotUsers

- Defined in services.ts:1037
Do not construct this object directly, use the botUsers property of an Ngrok client object instead.

Parameters
- httpClient: Wretcher
Returns BotUsers

Methods

create

create(arg: BotUserCreate): Promise<BotUser>

- Defined in services.ts:1043
Create a new bot user

Parameters
- arg: BotUserCreate
Returns Promise<BotUser>

delete

delete(id: any): Promise<void>

- Defined in services.ts:1053
Delete a bot user by ID

Parameters
- id: any
Returns Promise<void>

get

get(id: any): Promise<BotUser>

- Defined in services.ts:1063
Get the details of a Bot User by ID.

Parameters
- id: any
Returns Promise<BotUser>

list

list(beforeId?: string, limit?: string): Promise<BotUser[]>

- Defined in services.ts:1073
List all bot users in this account.

Parameters
- Optional beforeId: string
- Optional limit: string
Returns Promise<BotUser[]>

update

update(arg: BotUserUpdate): Promise<BotUser>

- Defined in services.ts:1121
Update attributes of a bot user by ID.

Parameters
- arg: BotUserUpdate
Returns Promise<BotUser>

Generated using TypeDoc