Type Alias ResourceType

Type declaration

• createResourceType:function

  • 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

• deleteResourceType:function

  • deleteResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>

    Delete resource type

    Parameters

    • resourceTypeUuid: string

      resource type uuid

    Returns Promise<ResourceTypeSkeleton>

    Promise resolvig to a resource type object

• deleteResourceTypeByName:function

  • 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

• exportResourceType:function

  • 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

• exportResourceTypeByName:function

  • 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

• exportResourceTypes:function

  • exportResourceTypes(): Promise<ResourceTypeExportInterface>

    Export resource types

    Returns Promise<ResourceTypeExportInterface>

    a promise that resolves to an ResourceTypeExportInterface object

• getResourceType:function

  • getResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>

    Get resource type

    Parameters

    • resourceTypeUuid: string

      resource type uuid

    Returns Promise<ResourceTypeSkeleton>

    a promise that resolves to a resource type object

    Deprecated

    since v2.0.0 use Agent.readResourceType | readResourceType instead

    readResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>
    Copy

• getResourceTypeByName:function

  • getResourceTypeByName(resourceTypeName: string): Promise<ResourceTypeSkeleton>

    Get resource type by name

    Parameters

    • resourceTypeName: string

      resource type name

    Returns Promise<ResourceTypeSkeleton>

    a promise that resolves to a resource type object

    Deprecated

    since v2.0.0 use Agent.readResourceTypeByName | readResourceTypeByName instead

    readResourceTypeByName(resourceTypeName: string): Promise<ResourceTypeSkeleton>
    Copy

• getResourceTypes:function

  • getResourceTypes(): Promise<ResourceTypeSkeleton[]>

    Get all resource types

    Returns Promise<ResourceTypeSkeleton[]>

    a promise that resolves to an array of resource type objects

    Deprecated

    since v2.0.0 use Agent.readResourceTypes | readResourceTypes instead

    readResourceTypes(): Promise<ResourceTypeSkeleton[]>
    Copy

• importFirstResourceType:function

  • importFirstResourceType(importData: ResourceTypeExportInterface): Promise<any>

    Import first resource type

    Parameters

    • importData: ResourceTypeExportInterface

      import data

    Returns Promise<any>

• importResourceType:function

  • importResourceType(
        resourceTypeUuid: string,
        importData: ResourceTypeExportInterface,
    ): Promise<any>

    Import resource type by uuid

    Parameters

    • resourceTypeUuid: string

      client uuid
    • importData: ResourceTypeExportInterface

      import data

    Returns Promise<any>

• importResourceTypeByName:function

  • importResourceTypeByName(
        resourceTypeName: string,
        importData: ResourceTypeExportInterface,
    ): Promise<any>

    Import resource type by name

    Parameters

    • resourceTypeName: string

      client id
    • importData: ResourceTypeExportInterface

      import data

    Returns Promise<any>

• importResourceTypes:function

  • importResourceTypes(importData: ResourceTypeExportInterface): Promise<any[]>

    Import resource types

    Parameters

    • importData: ResourceTypeExportInterface

      import data

    Returns Promise<any[]>

• readResourceType:function

  • 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

• readResourceTypeByName:function

  • 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

• readResourceTypes:function

  • readResourceTypes(): Promise<ResourceTypeSkeleton[]>

    Read all resource types

    Returns Promise<ResourceTypeSkeleton[]>

    a promise that resolves to an array of resource type objects

• updateResourceType:function

  • updateResourceType(
        resourceTypeUuid: string,
        resourceTypeData: ResourceTypeSkeleton,
    ): Promise<ResourceTypeSkeleton>

    Update resource type

    Parameters

    • resourceTypeUuid: string
    • resourceTypeData: ResourceTypeSkeleton

      resource type data

    Returns Promise<ResourceTypeSkeleton>

    a promise that resolves to a resource type object