@rockcarver/frodo-lib/types/api/ResourceTypesApi.d.ts

A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.

import { State } from '../shared/State';
import { type NoIdObjectSkeletonInterface } from './ApiTypes';
export type ResourceTypeSkeleton = NoIdObjectSkeletonInterface & {
    uuid: string;
    name: string;
};
/**
 * Get all resource types
 * @returns {Promise} a promise that resolves to an object containing an array of resource type objects
 */
export declare function getResourceTypes({ state }: {
    state: State;
}): Promise<any>;
/**
 * Get resource type by uuid
 * @param {String} resourceTypeUuid resource type uuid
 * @returns {Promise} a promise that resolves to a node object
 */
export declare function getResourceType({ resourceTypeUuid, state, }: {
    resourceTypeUuid: string;
    state: State;
}): Promise<any>;
/**
 * Get resource type by name
 * @param {string} resourceTypeName resource type name
 * @returns {Promise} a promise that resolves to a node object
 */
export declare function getResourceTypeByName({ resourceTypeName, state, }: {
    resourceTypeName: string;
    state: State;
}): Promise<any>;
/**
 * Create resource type by uuid
 * @param {string} resourceTypeUuid resource type uuid
 * @param {Object} resourceTypeData resource type object
 * @returns {Promise<ResourceTypeSkeleton>} a promise that resolves to a resource type object
 */
export declare function createResourceType({ resourceTypeData, state, }: {
    resourceTypeData: ResourceTypeSkeleton;
    state: State;
}): Promise<ResourceTypeSkeleton>;
/**
 * Update resource type by uuid
 * @param {string} resourceTypeUuid resource type uuid
 * @param {ResourceTypeSkeleton} resourceTypeData resource type object
 * @returns {Promise<ResourceTypeSkeleton>} a promise that resolves to a resource type object
 */
export declare function putResourceType({ resourceTypeUuid, resourceTypeData, failIfExists, state, }: {
    resourceTypeUuid: string;
    resourceTypeData: ResourceTypeSkeleton;
    failIfExists?: boolean;
    state: State;
}): Promise<ResourceTypeSkeleton>;
/**
 * Delete resource type
 * @param {String} resourceTypeUuid resource type uuid
 * @returns {Promise} a promise that resolves to an object containing a resource type object
 */
export declare function deleteResourceType({ resourceTypeUuid, state, }: {
    resourceTypeUuid: string;
    state: State;
}): Promise<any>;
//# sourceMappingURL=ResourceTypesApi.d.ts.map