Class default

Hierarchy

default
- default

Index

Constructors

constructor

new default(__namedParameters: {
requestBuilder: default;
requestHandler: default;
}): default
Parameters
- __namedParameters: {
  requestBuilder: default;
  requestHandler: default;
  }
  - requestBuilder: default
  - requestHandler: default
Returns default
Inherited from default.constructor
- Defined in collections/abstractCollection.ts:13

Properties

`Protected` requestBuilder

requestBuilder: default

`Protected` requestHandler

requestHandler: default

Methods

`Protected` createAndSendRequest

createAndSendRequest(pathname: string, __namedParameters?: {
    body?: unknown;
    method?: Method;
    query?: {
        [key: string]: number | string | string[];
    };
}): Promise<any>
Parameters
- pathname: string
- __namedParameters: {
      body?: unknown;
      method?: Method;
      query?: {
          [key: string]: number | string | string[];
      };
  } = {}
  - Optional body?: unknown
  - Optional method?: Method
  - Optional query?: {
    [key: string]: number | string | string[];
    }
    - [key: string]: number | string | string[]
Returns Promise<any>
Inherited from default.createAndSendRequest
- Defined in collections/abstractCollection.ts:24

deletePermissionRole

deletePermissionRole(id: string): Promise<void>
Delete an editable permission role
Parameters
- id: string
Returns Promise<void>
- Defined in collections/permissionRoles.ts:63

get

get(options?: Partial<TeamId>): Promise<ResultSetResponse<PermissionRoleResponse>>
Retrieve permission roles
Parameters
- Optional options: Partial<TeamId>
Returns Promise<ResultSetResponse<PermissionRoleResponse>>
- Defined in collections/permissionRoles.ts:13

getGlobal

getGlobal(): Promise<ResultSetResponse<PermissionRoleResponse>>
Retrieve global permission roles

Returns Promise<ResultSetResponse<PermissionRoleResponse>>
- Defined in collections/permissionRoles.ts:34

getPermissionRole

getPermissionRole(id: string): Promise<PermissionRoleResponse>
Retrieve a permission role
Parameters
- id: string
Returns Promise<PermissionRoleResponse>
- Defined in collections/permissionRoles.ts:41

post

post(permissionRole: PermissionRole): Promise<PermissionRoleResponse>
Create a new editable permission role
Parameters
- permissionRole: PermissionRole
Returns Promise<PermissionRoleResponse>
- Defined in collections/permissionRoles.ts:24

putPermissionRole

putPermissionRole(id: string, permissionRole: PermissionRole): Promise<PermissionRoleResponse>
Update a permission role. Only members of editable roles can be updated.
Parameters
- id: string
- permissionRole: PermissionRole
Returns Promise<PermissionRoleResponse>
- Defined in collections/permissionRoles.ts:50

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: { requestBuilder: default; requestHandler: default; }

requestBuilder: default

requestHandler: default

Returns default

Properties

Protected requestBuilder

Protected requestHandler

Methods

Protected createAndSendRequest

Parameters

pathname: string

__namedParameters: { body?: unknown; method?: Method; query?: { [key: string]: number | string | string[]; }; } = {}

Optional body?: unknown

Optional method?: Method

Optional query?: { [key: string]: number | string | string[]; }

[key: string]: number | string | string[]

Returns Promise<any>

deletePermissionRole

Parameters

id: string

Returns Promise<void>

get

Parameters

Optional options: Partial<TeamId>

Returns Promise<ResultSetResponse<PermissionRoleResponse>>

getGlobal

Returns Promise<ResultSetResponse<PermissionRoleResponse>>

getPermissionRole

Parameters

id: string

Returns Promise<PermissionRoleResponse>

post

Parameters

permissionRole: PermissionRole

Returns Promise<PermissionRoleResponse>

putPermissionRole

Parameters

id: string

permissionRole: PermissionRole

Returns Promise<PermissionRoleResponse>

Settings

Member Visibility

Theme

__namedParameters: {
requestBuilder: default;
requestHandler: default;
}

`Protected` requestBuilder

`Protected` requestHandler

`Protected` createAndSendRequest

__namedParameters: {
body?: unknown;
method?: Method;
query?: {
[key: string]: number | string | string[];
};
} = {}

`Optional` body?: unknown

`Optional` method?: Method

`Optional` query?: {
[key: string]: number | string | string[];
}

`Optional` options: Partial<TeamId>