@acceleratxr/core_sdk / OrganizationService
Class: OrganizationService#
Hierarchy#
-
↳ OrganizationService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new OrganizationService(apiClient: ApiClient, config: Configuration): OrganizationService
Overrides ServiceBase.constructor
Defined in src/services/OrganizationService.ts:10
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: OrganizationService
Properties#
apiClient#
• Protected apiClient: ApiClient
Inherited from ServiceBase.apiClient
Defined in src/ServiceBase.ts:14
The API Client used when making requests to the API backend server.
config#
• Protected config: Configuration
Inherited from ServiceBase.config
Defined in src/ServiceBase.ts:19
The SDK configuration to use.
uuid#
▪ Static uuid: string = “f059d860-3809-48e8-af73-a5f614a82cbf”
Defined in src/services/OrganizationService.ts:16
Methods#
count#
▸ count(query?: any): Promise<number>
Defined in src/services/OrganizationService.ts:57
Returns the count of groups
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<number>
create#
▸ create(obj: Organization): Promise<Organization | undefined>
Defined in src/services/OrganizationService.ts:33
Create a new group
Parameters:#
Name |
Type |
|---|---|
|
Returns: Promise<Organization | undefined>
delete#
▸ delete(id: string): Promise<void>
Defined in src/services/OrganizationService.ts:102
Deletes the group
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<void>
findAll#
▸ findAll(query?: any): Promise<Organization[] | undefined>
Defined in src/services/OrganizationService.ts:21
Returns all groups from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<Organization[] | undefined>
findById#
▸ findById(id: string): Promise<Organization | undefined>
Defined in src/services/OrganizationService.ts:76
Returns a single group from the system that the user has access to
Parameters:#
Name |
Type |
|---|---|
|
string |
Returns: Promise<Organization | undefined>
truncate#
▸ truncate(query?: any): Promise<void>
Defined in src/services/OrganizationService.ts:45
Deletes all roles from the service.
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: Promise<void>
update#
▸ update(id: string, obj: Organization): Promise<Organization | undefined>
Defined in src/services/OrganizationService.ts:89
Updates a single group
Parameters:#
Name |
Type |
|---|---|
|
string |
|
Returns: Promise<Organization | undefined>