Class RolesClient

Client to call OrganizationMemberRoles schema

Hierarchy

RolesClient

Index

Constructors

constructor

Properties

client

Methods

get
list

Constructors

constructor

new RolesClient(client: ClassDoAPIClient): RolesClient

- Defined in clients/Roles.ts:8
Parameters
- client: ClassDoAPIClient
Returns RolesClient

Properties

Private client

client: ClassDoAPIClient

Methods

get

get<OMR>(fields: OMR[], id: string): Promise<Result<OrganizationMemberRolesResult<OMR>>>

- Defined in clients/Roles.ts:48
Get a role.
```
client.roles.get(['id'], 'xxxxxxxxxxx').then(v => {
  console.log(v)
})
```
Type parameters
- OMR: OrganizationMemberRoleKeys | null
Parameters
- fields: OMR[]
  
  Array of OrganizationMemberRole key names. Returns specified fields as result.
- id: string
  
  OrganizationMemberRole id.
Returns Promise<Result<OrganizationMemberRolesResult<OMR>>>

list

list<OMR>(fields: OMR[], args?: OrganizationRolesArgs | null | undefined): Promise<Result<OrganizationMemberRolesResult<OMR>>>

- Defined in clients/Roles.ts:23
Get list of OrganizationMemberRoles.
```
const rolesResult = client.roles.list(['id', 'name']).then(v => {
  console.log(v)
})
```
Type parameters
- OMR: OrganizationMemberRoleKeys | null
Parameters
- fields: OMR[]
  
  Array of OrganizationMemberRole key names. Returns specified fields as result.
- Optional args: OrganizationRolesArgs | null | undefined
Returns Promise<Result<OrganizationMemberRolesResult<OMR>>>

Generated using TypeDoc