Class ServiceUsers

Hierarchy

ServiceUsers

Index

Constructors

constructor

Methods

Constructors

constructor

new ServiceUsers(httpClient: Wretcher): ServiceUsers

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

Parameters
- httpClient: Wretcher
Returns ServiceUsers

Methods

create

create(arg: ServiceUserCreate): Promise<ServiceUser>

- Defined in services.ts:3503
Create a new service user

Parameters
- arg: ServiceUserCreate
Returns Promise<ServiceUser>

delete

delete(id: any): Promise<void>

- Defined in services.ts:3515
Delete a service user by ID

Parameters
- id: any
Returns Promise<void>

get

get(id: any): Promise<ServiceUser>

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

Parameters
- id: any
Returns Promise<ServiceUser>

list

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

- Defined in services.ts:3535
List all service users in this account.

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

update

update(arg: ServiceUserUpdate): Promise<ServiceUser>

- Defined in services.ts:3585
Update attributes of a service user by ID.

Parameters
- arg: ServiceUserUpdate
Returns Promise<ServiceUser>

Generated using TypeDoc