Type Alias ResourceType

type ResourceType = {
    createResourceType(
        resourceTypeData: ResourceTypeSkeleton,
        resourceTypeUuid?: string,
    ): Promise<ResourceTypeSkeleton>;
    deleteResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>;
    deleteResourceTypeByName(
        resourceTypeName: string,
    ): Promise<ResourceTypeSkeleton>;
    exportResourceType(
        resourceTypeUuid: string,
    ): Promise<ResourceTypeExportInterface>;
    exportResourceTypeByName(
        resourceTypeName: string,
    ): Promise<ResourceTypeExportInterface>;
    exportResourceTypes(): Promise<ResourceTypeExportInterface>;
    importFirstResourceType(
        importData: ResourceTypeExportInterface,
    ): Promise<ResourceTypeSkeleton>;
    importResourceType(
        resourceTypeUuid: string,
        importData: ResourceTypeExportInterface,
    ): Promise<ResourceTypeSkeleton>;
    importResourceTypeByName(
        resourceTypeName: string,
        importData: ResourceTypeExportInterface,
    ): Promise<ResourceTypeSkeleton>;
    importResourceTypes(
        importData: ResourceTypeExportInterface,
    ): Promise<ResourceTypeSkeleton[]>;
    readResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>;
    readResourceTypeByName(
        resourceTypeName: string,
    ): Promise<ResourceTypeSkeleton>;
    readResourceTypes(): Promise<ResourceTypeSkeleton[]>;
    updateResourceType(
        resourceTypeUuid: string,
        resourceTypeData: ResourceTypeSkeleton,
    ): Promise<ResourceTypeSkeleton>;
}

Index

Methods

createResourceType deleteResourceType deleteResourceTypeByName exportResourceType exportResourceTypeByName exportResourceTypes importFirstResourceType importResourceType importResourceTypeByName importResourceTypes readResourceType readResourceTypeByName readResourceTypes updateResourceType

Methods

createResourceType

createResourceType(
resourceTypeData: ResourceTypeSkeleton,
resourceTypeUuid?: string,
): Promise<ResourceTypeSkeleton>
Create resource type
Parameters
- resourceTypeData: ResourceTypeSkeleton
  resource type data
- OptionalresourceTypeUuid: string
  resource type uuid
Returns Promise<ResourceTypeSkeleton>
a promise that resolves to a resource type object
- Defined in ops/ResourceTypeOps.ts:48

deleteResourceType

deleteResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>
Delete resource type
Parameters
- resourceTypeUuid: string
  resource type uuid
Returns Promise<ResourceTypeSkeleton>
Promise resolvig to a resource type object
- Defined in ops/ResourceTypeOps.ts:67

deleteResourceTypeByName

deleteResourceTypeByName(
resourceTypeName: string,
): Promise<ResourceTypeSkeleton>
Delete resource type by name
Parameters
- resourceTypeName: string
  resource type name
Returns Promise<ResourceTypeSkeleton>
Promise resolvig to a resource type object
- Defined in ops/ResourceTypeOps.ts:73

exportResourceType

exportResourceType(
resourceTypeUuid: string,
): Promise<ResourceTypeExportInterface>
Export resource type
Parameters
- resourceTypeUuid: string
  resource type uuid
Returns Promise<ResourceTypeExportInterface>
a promise that resolves to an ResourceTypeExportInterface object
- Defined in ops/ResourceTypeOps.ts:81

exportResourceTypeByName

exportResourceTypeByName(
resourceTypeName: string,
): Promise<ResourceTypeExportInterface>
Export resource type by name
Parameters
- resourceTypeName: string
  resource type name
Returns Promise<ResourceTypeExportInterface>
a promise that resolves to an ResourceTypeExportInterface object
- Defined in ops/ResourceTypeOps.ts:89

exportResourceTypes

exportResourceTypes(): Promise<ResourceTypeExportInterface>
Export resource types

Returns Promise<ResourceTypeExportInterface>
a promise that resolves to an ResourceTypeExportInterface object
- Defined in ops/ResourceTypeOps.ts:96

importFirstResourceType

importFirstResourceType(
importData: ResourceTypeExportInterface,
): Promise<ResourceTypeSkeleton>
Import first resource type
Parameters
- importData: ResourceTypeExportInterface
  import data
Returns Promise<ResourceTypeSkeleton>
a promise that resolves to the imported resource type object, or null if no update was made
- Defined in ops/ResourceTypeOps.ts:122

importResourceType

importResourceType(
resourceTypeUuid: string,
importData: ResourceTypeExportInterface,
): Promise<ResourceTypeSkeleton>
Import resource type by uuid
Parameters
- resourceTypeUuid: string
  client uuid
- importData: ResourceTypeExportInterface
  import data
Returns Promise<ResourceTypeSkeleton>
a promise that resolves to the imported resource type object, or null if no update was made
- Defined in ops/ResourceTypeOps.ts:103

importResourceTypeByName

importResourceTypeByName(
resourceTypeName: string,
importData: ResourceTypeExportInterface,
): Promise<ResourceTypeSkeleton>
Import resource type by name
Parameters
- resourceTypeName: string
  client id
- importData: ResourceTypeExportInterface
  import data
Returns Promise<ResourceTypeSkeleton>
a promise that resolves to the imported resource type object, or null if no update was made
- Defined in ops/ResourceTypeOps.ts:113

importResourceTypes

importResourceTypes(
importData: ResourceTypeExportInterface,
): Promise<ResourceTypeSkeleton[]>
Import resource types
Parameters
- importData: ResourceTypeExportInterface
  import data
Returns Promise<ResourceTypeSkeleton[]>
a promise that resolves to the imported resource type objects
- Defined in ops/ResourceTypeOps.ts:130

readResourceType

readResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>
Read resource type
Parameters
- resourceTypeUuid: string
  resource type uuid
Returns Promise<ResourceTypeSkeleton>
a promise that resolves to a resource type object
- Defined in ops/ResourceTypeOps.ts:28

readResourceTypeByName

readResourceTypeByName(resourceTypeName: string): Promise<ResourceTypeSkeleton>
Read resource type by name
Parameters
- resourceTypeName: string
  resource type name
Returns Promise<ResourceTypeSkeleton>
a promise that resolves to a resource type object
- Defined in ops/ResourceTypeOps.ts:39

readResourceTypes

readResourceTypes(): Promise<ResourceTypeSkeleton[]>
Read all resource types

Returns Promise<ResourceTypeSkeleton[]>
a promise that resolves to an array of resource type objects
- Defined in ops/ResourceTypeOps.ts:33

updateResourceType

updateResourceType(
resourceTypeUuid: string,
resourceTypeData: ResourceTypeSkeleton,
): Promise<ResourceTypeSkeleton>
Update resource type
Parameters
- resourceTypeUuid: string
  resource type uuid
- resourceTypeData: ResourceTypeSkeleton
  resource type data
Returns Promise<ResourceTypeSkeleton>
a promise that resolves to a resource type object, or null if no update was made
- Defined in ops/ResourceTypeOps.ts:58

Type Alias ResourceType

Index

Methods

Methods

createResourceType

Parameters

Returns Promise<ResourceTypeSkeleton>

deleteResourceType

Parameters

Returns Promise<ResourceTypeSkeleton>

deleteResourceTypeByName

Parameters

Returns Promise<ResourceTypeSkeleton>

exportResourceType

Parameters

Returns Promise<ResourceTypeExportInterface>

exportResourceTypeByName

Parameters

Returns Promise<ResourceTypeExportInterface>

exportResourceTypes

Returns Promise<ResourceTypeExportInterface>

importFirstResourceType

Parameters

Returns Promise<ResourceTypeSkeleton>

importResourceType

Parameters

Returns Promise<ResourceTypeSkeleton>

importResourceTypeByName

Parameters

Returns Promise<ResourceTypeSkeleton>

importResourceTypes

Parameters

Returns Promise<ResourceTypeSkeleton[]>

readResourceType

Parameters

Returns Promise<ResourceTypeSkeleton>

readResourceTypeByName

Parameters

Returns Promise<ResourceTypeSkeleton>

readResourceTypes

Returns Promise<ResourceTypeSkeleton[]>

updateResourceType

Parameters

Returns Promise<ResourceTypeSkeleton>

Settings

On This Page