Class RolesResource

Roles management resource (standard roles, not alias roles)

Hierarchy

BaseResource
- RolesResource

Index

Constructors

Properties

Methods

create delete get getPermissions list request update validateId validateRequiredString

Constructors

constructor

new RolesResource(client: TenantosClient): RolesResource
Parameters
- client: TenantosClient
Returns RolesResource
Inherited from BaseResource.constructor
- Defined in resources.ts:85

Properties

`Protected` `Readonly`client

client: TenantosClient

Methods

create

create(data: any): Promise<Role>
Parameters
- data: any
Returns Promise<Role>
- Defined in resources.ts:770

delete

delete(id: number): Promise<void>
Parameters
- id: number
Returns Promise<void>
- Defined in resources.ts:800

get

get(id: number): Promise<Role>
Parameters
- id: number
Returns Promise<Role>
- Defined in resources.ts:755

getPermissions

getPermissions(): Promise<string[]>
Returns Promise<string[]>
- Defined in resources.ts:809

list

list(): Promise<Role[]>
Returns Promise<Role[]>
- Defined in resources.ts:746

`Protected`request

request<T>(config: RequestConfig): Promise<ApiResponse<T>>
Make a request to the API with automatic error handling
Type Parameters
- T
Parameters
- config: RequestConfig
Returns Promise<ApiResponse<T>>
Inherited from BaseResource.request
- Defined in resources.ts:90

update

update(id: number, data: any): Promise<Role>
Parameters
- id: number
- data: any
Returns Promise<Role>
- Defined in resources.ts:784

`Protected`validateId

validateId(id: number, resourceName?: string): void
Validate that an ID is a positive integer
Parameters
- id: number
- resourceName: string = 'Resource'
Returns void
Inherited from BaseResource.validateId
- Defined in resources.ts:97

`Protected`validateRequiredString

validateRequiredString(value: string, fieldName: string): void
Validate required string field
Parameters
- value: string
- fieldName: string
Returns void
Inherited from BaseResource.validateRequiredString
- Defined in resources.ts:106