Skip to main content

Function: roleService()

roleService(client): object

Defined in: service/RoleService.ts:25

Service class for Role and RoleDefinition-related GraphQL operations

Parameters

client

GraphQLClient

Returns

createRole()

createRole(input): Promise<Role>

Creates a new role *

Parameters

input

RoleCreateInput

Role creation input data *

Returns

Promise<Role>

Promise<Role> The created role

createRoleDefinition()

createRoleDefinition(input): Promise&lt;RoleDefinition>

Creates a new role definition *

Parameters

input

RoleDefinitionCreateInput

RoleDefinition creation input data *

Returns

Promise&lt;RoleDefinition>

Promise<RoleDefinition> The created role definition

getRole()

getRole(id): Promise&lt;Role>

Fetches a single role by ID *

Parameters

id

number

Role ID to fetch *

Returns

Promise&lt;Role>

Promise<Role> The role data

getRoleDefinition()

getRoleDefinition(id): Promise&lt;RoleDefinition>

Fetches a single role definition by ID *

Parameters

id

number

RoleDefinition ID to fetch *

Returns

Promise&lt;RoleDefinition>

Promise<RoleDefinition> The role definition data

getRoleDefinitions()

getRoleDefinitions(input?): Promise&lt;RoleDefinitionResponse>

Fetches a list of role definitions with search criteria *

Parameters

input?

RoleDefinitionSearchInput

RoleDefinition search input parameters *

Returns

Promise&lt;RoleDefinitionResponse>

Promise<RoleDefinitionResponse> The role definitions response data

getRoles()

getRoles(input?): Promise&lt;RoleResponse>

Fetches a list of roles with search criteria *

Parameters

input?

RoleSearchInput

Role search input parameters *

Returns

Promise&lt;RoleResponse>

Promise<RoleResponse> The roles response data

updateRole()

updateRole(variables): Promise&lt;Role>

Updates an existing role *

Parameters

variables

RoleUpdateVariables

Role update input data *

Returns

Promise&lt;Role>

Promise<Role> The updated role

updateRoleDefinition()

updateRoleDefinition(variables): Promise&lt;RoleDefinition>

Updates an existing role definition *

Parameters

variables

RoleDefinitionUpdateVariables

RoleDefinition update input data *

Returns

Promise&lt;RoleDefinition>

Promise<RoleDefinition> The updated role definition