@rockcarver/frodo-lib 4.10.0 → 4.11.0

package/types/ops/cloud/iga/IgaGlossaryOps.d.ts

@@ -0,0 +1,241 @@
+import { GlossaryObjectType, GlossarySchemaItemSkeleton } from '../../../api/cloud/iga/IgaGlossaryApi';
+import { State } from '../../../shared/State';
+import { ExportMetaData, ResultCallback } from '../../OpsTypes';
+export type Glossary = {
+    /**
+     * Create glossary schema
+     * @param {GlossarySchemaItemSkeleton} glossarySchemaData the glossary schema object
+     * @returns {Promise<GlossarySchemaItemSkeleton>} a promise that resolves to a glossary schema object
+     */
+    createGlossarySchema(glossarySchemaData: GlossarySchemaItemSkeleton<any>): Promise<GlossarySchemaItemSkeleton<any>>;
+    /**
+     * Read glossary schema
+     * @param {string} glossaryId the glossary schema id
+     * @returns {Promise<GlossarySchemaItemSkeleton>} a promise that resolves to a glossary schema object
+     */
+    readGlossarySchema(glossaryId: string): Promise<GlossarySchemaItemSkeleton<any>>;
+    /**
+     * Read glossary schema by its name and object type
+     * @param {string} glossaryName the glossary schema name
+     * @param {GlossaryObjectType} objectType the glossary schema object type
+     * @returns {Promise<GlossarySchemaItemSkeleton>} a promise that resolves to a glossary schema object
+     */
+    readGlossarySchemaByNameAndObjectType(glossaryName: string, objectType: GlossaryObjectType): Promise<GlossarySchemaItemSkeleton<any>>;
+    /**
+     * Read all glossary schemas
+     * @returns {Promise<GlossarySchemaItemSkeleton[]>} a promise that resolves to an array of glossary schema objects
+     */
+    readGlossarySchemas(): Promise<GlossarySchemaItemSkeleton<any>[]>;
+    /**
+     * Export glossary schema
+     * @param {string} glossaryId the glossary schema id
+     * @returns {Promise<GlossarySchemaExportInterface>} a promise that resolves to a glossary schema export object
+     */
+    exportGlossarySchema(glossaryId: string): Promise<GlossarySchemaExportInterface>;
+    /**
+     * Export glossary schema by its name and object type
+     * @param {string} glossaryName the glossary schema name
+     * @param {GlossaryObjectType} objectType the glossary schema object type
+     * @returns {Promise<GlossarySchemaExportInterface>} a promise that resolves to a glossary schema export object
+     */
+    exportGlossarySchemaByNameAndObjectType(glossaryName: string, objectType: GlossaryObjectType): Promise<GlossarySchemaExportInterface>;
+    /**
+     * Export all glossary schemas
+     * @param {GlossarySchemaExportOptions} options export options
+     * @returns {Promise<GlossarySchemaExportInterface>} a promise that resolves to a glossary schema export object
+     */
+    exportGlossarySchemas(options?: GlossarySchemaExportOptions): Promise<GlossarySchemaExportInterface>;
+    /**
+     * Update glossary schema
+     * @param {string} glossaryId the glossary schema id
+     * @param {GlossarySchemaItemSkeleton} glossarySchemaData the glossary schema object
+     * @returns {Promise<GlossarySchemaItemSkeleton>} a promise that resolves to a glossary schema object
+     */
+    updateGlossarySchema(glossaryId: string, glossarySchemaData: GlossarySchemaItemSkeleton<any>): Promise<GlossarySchemaItemSkeleton<any>>;
+    /**
+     * Import glossary schemas
+     * @param {string} glossaryId The glossary schema id.  If supplied, only the glossary schema of that id is imported. Takes priority over glossaryName/objectType if they are all provided.
+     * @param {string} glossaryName The glossary schema name. If supplied along with the objectType, only the glossary schema of that name/objectType is imported.
+     * @param {GlossaryObjectType} objectType the glossary schema object type
+     * @param {GlossarySchemaExportInterface} importData glossary schema import data
+     * @param {GlossarySchemaImportOptions} options import options
+     * @param {ResultCallback<GlossarySchemaItemSkeleton>} resultCallback Optional callback to process individual results
+     * @returns {Promise<GlossarySchemaItemSkeleton[]>} the imported glossary schemas
+     */
+    importGlossarySchemas(importData: GlossarySchemaExportInterface, glossaryId?: string, glossaryName?: string, objectType?: GlossaryObjectType, options?: GlossarySchemaImportOptions, resultCallback?: ResultCallback<GlossarySchemaItemSkeleton<any>>): Promise<GlossarySchemaItemSkeleton<any>[]>;
+    /**
+     * Delete glossary schema
+     * @param {string} glossaryId the glossary schema id
+     * @returns {Promise<GlossarySchemaItemSkeleton>} a promise that resolves to a glossary schema object
+     */
+    deleteGlossarySchema(glossaryId: string): Promise<GlossarySchemaItemSkeleton<any>>;
+    /**
+     * Delete glossary schema by its name and object type
+     * @param {string} glossaryName the glossary schema name
+     * @param {GlossaryObjectType} objectType the glossary schema object type
+     * @returns {Promise<GlossarySchemaItemSkeleton>} a promise that resolves to a glossary schema object
+     */
+    deleteGlossarySchemaByNameAndObjectType(glossaryName: string, objectType: GlossaryObjectType): Promise<GlossarySchemaItemSkeleton<any>>;
+    /**
+     * Delete glossary schemas
+     * @param {ResultCallback} resultCallback Optional callback to process individual results
+     * @returns {Promise<GlossarySchemaItemSkeleton[]>} promise that resolves to an array of glossary schema objects
+     */
+    deleteGlossarySchemas(resultCallback?: ResultCallback<GlossarySchemaItemSkeleton<any>>): Promise<GlossarySchemaItemSkeleton<any>[]>;
+};
+declare const _default: (state: State) => Glossary;
+export default _default;
+export interface GlossarySchemaExportInterface {
+    meta?: ExportMetaData;
+    glossarySchema: Record<string, GlossarySchemaItemSkeleton<any>>;
+}
+/**
+ * Glossary schema import options
+ */
+export interface GlossarySchemaImportOptions {
+    /**
+     * Include internal glossary schema in import if true
+     */
+    includeInternal: boolean;
+}
+/**
+ * Glossary schema export options
+ */
+export interface GlossarySchemaExportOptions {
+    /**
+     * Include internal glossary schema in export if true
+     */
+    includeInternal: boolean;
+}
+/**
+ * Create an empty glossary schema export template
+ * @returns {GlossarySchemaExportInterface} an empty glossary schema export template
+ */
+export declare function createGlossarySchemaExportTemplate({ state, }: {
+    state: State;
+}): GlossarySchemaExportInterface;
+/**
+ * Create glossary schema
+ * @param {GlossarySchemaItemSkeleton} glossarySchemaData the glossary schema object
+ * @returns {Promise<GlossarySchemaItemSkeleton>} a promise that resolves to a glossary schema object
+ */
+export declare function createGlossarySchema({ glossarySchemaData, state, }: {
+    glossarySchemaData: GlossarySchemaItemSkeleton<any>;
+    state: State;
+}): Promise<GlossarySchemaItemSkeleton<any>>;
+/**
+ * Read glossary schema
+ * @param {string} glossaryId the glossary schema id
+ * @returns {Promise<GlossarySchemaItemSkeleton>} a promise that resolves to a glossary schema object
+ */
+export declare function readGlossarySchema({ glossaryId, state, }: {
+    glossaryId: string;
+    state: State;
+}): Promise<GlossarySchemaItemSkeleton<any>>;
+/**
+ * Read glossary schema by its name and object type
+ * @param {string} glossaryName the glossary schema name
+ * @param {GlossaryObjectType} objectType the glossary schema object type
+ * @returns {Promise<GlossarySchemaItemSkeleton>} a promise that resolves to a glossary schema object
+ */
+export declare function readGlossarySchemaByNameAndObjectType({ glossaryName, objectType, state, }: {
+    glossaryName: string;
+    objectType: GlossaryObjectType;
+    state: State;
+}): Promise<GlossarySchemaItemSkeleton<any>>;
+/**
+ * Read all glossary schemas
+ * @returns {Promise<GlossarySchemaItemSkeleton[]>} a promise that resolves to an array of glossary schema objects
+ */
+export declare function readGlossarySchemas({ state, }: {
+    state: State;
+}): Promise<GlossarySchemaItemSkeleton<any>[]>;
+/**
+ * Export glossary schema
+ * @param {string} glossaryId the glossary schema id
+ * @returns {Promise<GlossarySchemaExportInterface>} a promise that resolves to a glossary schema export object
+ */
+export declare function exportGlossarySchema({ glossaryId, state, }: {
+    glossaryId: string;
+    state: State;
+}): Promise<GlossarySchemaExportInterface>;
+/**
+ * Export glossary schema by its name and object type
+ * @param {string} glossaryName the glossary schema name
+ * @param {GlossaryObjectType} objectType the glossary schema object type
+ * @returns {Promise<GlossarySchemaExportInterface>} a promise that resolves to a glossary schema export object
+ */
+export declare function exportGlossarySchemaByNameAndObjectType({ glossaryName, objectType, state, }: {
+    glossaryName: string;
+    objectType: GlossaryObjectType;
+    state: State;
+}): Promise<GlossarySchemaExportInterface>;
+/**
+ * Export all glossary schemas
+ * @param {GlossarySchemaExportOptions} options export options
+ * @returns {Promise<GlossarySchemaExportInterface>} a promise that resolves to a glossary schema export object
+ */
+export declare function exportGlossarySchemas({ options, state, }: {
+    options?: GlossarySchemaExportOptions;
+    state: State;
+}): Promise<GlossarySchemaExportInterface>;
+/**
+ * Update glossary schema
+ * @param {string} glossaryId the glossary schema id
+ * @param {GlossarySchemaItemSkeleton} glossarySchemaData the glossary schema object
+ * @returns {Promise<GlossarySchemaItemSkeleton>} a promise that resolves to a glossary schema object
+ */
+export declare function updateGlossarySchema({ glossaryId, glossarySchemaData, state, }: {
+    glossaryId: string;
+    glossarySchemaData: GlossarySchemaItemSkeleton<any>;
+    state: State;
+}): Promise<GlossarySchemaItemSkeleton<any>>;
+/**
+ * Import glossary schemas
+ * @param {string} glossaryId The glossary schema id.  If supplied, only the glossary schema of that id is imported. Takes priority over glossaryName/objectType if they are all provided.
+ * @param {string} glossaryName The glossary schema name. If supplied along with the objectType, only the glossary schema of that name/objectType is imported.
+ * @param {GlossaryObjectType} objectType the glossary schema object type
+ * @param {GlossarySchemaExportInterface} importData glossary schema import data
+ * @param {GlossarySchemaImportOptions} options import options
+ * @param {ResultCallback<GlossarySchemaItemSkeleton>} resultCallback Optional callback to process individual results
+ * @returns {Promise<GlossarySchemaItemSkeleton[]>} the imported glossary schemas
+ */
+export declare function importGlossarySchemas({ glossaryId, glossaryName, objectType, importData, options, resultCallback, state, }: {
+    glossaryId?: string;
+    glossaryName?: string;
+    objectType?: GlossaryObjectType;
+    importData: GlossarySchemaExportInterface;
+    options?: GlossarySchemaImportOptions;
+    resultCallback?: ResultCallback<GlossarySchemaItemSkeleton<any>>;
+    state: State;
+}): Promise<GlossarySchemaItemSkeleton<any>[]>;
+/**
+ * Delete glossary schema
+ * @param {string} glossaryId the glossary schema id
+ * @returns {Promise<GlossarySchemaItemSkeleton>} a promise that resolves to a glossary schema object
+ */
+export declare function deleteGlossarySchema({ glossaryId, state, }: {
+    glossaryId: string;
+    state: State;
+}): Promise<GlossarySchemaItemSkeleton<any>>;
+/**
+ * Delete glossary schema by its name and object type
+ * @param {string} glossaryName the glossary schema name
+ * @param {GlossaryObjectType} objectType the glossary schema object type
+ * @returns {Promise<GlossarySchemaItemSkeleton>} a promise that resolves to a glossary schema object
+ */
+export declare function deleteGlossarySchemaByNameAndObjectType({ glossaryName, objectType, state, }: {
+    glossaryName: string;
+    objectType: GlossaryObjectType;
+    state: State;
+}): Promise<GlossarySchemaItemSkeleton<any>>;
+/**
+ * Delete glossary schemas
+ * @param {ResultCallback} resultCallback Optional callback to process individual results
+ * @returns {Promise<GlossarySchemaItemSkeleton[]>} promise that resolves to an array of glossary schema objects
+ */
+export declare function deleteGlossarySchemas({ resultCallback, state, }: {
+    resultCallback?: ResultCallback<GlossarySchemaItemSkeleton<any>>;
+    state: State;
+}): Promise<GlossarySchemaItemSkeleton<any>[]>;
+//# sourceMappingURL=IgaGlossaryOps.d.ts.map

package/types/ops/cloud/iga/IgaGlossaryOps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IgaGlossaryOps.d.ts","sourceRoot":"","sources":["../../../../src/ops/cloud/iga/IgaGlossaryOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,kBAAkB,EAClB,0BAA0B,EAG3B,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAS9C,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhE,MAAM,MAAM,QAAQ,GAAG;IACrB;;;;OAIG;IACH,oBAAoB,CAClB,kBAAkB,EAAE,0BAA0B,CAAC,GAAG,CAAC,GAClD,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C;;;;OAIG;IACH,kBAAkB,CAChB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C;;;;;OAKG;IACH,qCAAqC,CACnC,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,kBAAkB,GAC7B,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C;;;OAGG;IACH,mBAAmB,IAAI,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAClE;;;;OAIG;IACH,oBAAoB,CAClB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC1C;;;;;OAKG;IACH,uCAAuC,CACrC,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,kBAAkB,GAC7B,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC1C;;;;OAIG;IACH,qBAAqB,CACnB,OAAO,CAAC,EAAE,2BAA2B,GACpC,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC1C;;;;;OAKG;IACH,oBAAoB,CAClB,UAAU,EAAE,MAAM,EAClB,kBAAkB,EAAE,0BAA0B,CAAC,GAAG,CAAC,GAClD,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C;;;;;;;;;OASG;IACH,qBAAqB,CACnB,UAAU,EAAE,6BAA6B,EACzC,UAAU,CAAC,EAAE,MAAM,EACnB,YAAY,CAAC,EAAE,MAAM,EACrB,UAAU,CAAC,EAAE,kBAAkB,EAC/B,OAAO,CAAC,EAAE,2BAA2B,EACrC,cAAc,CAAC,EAAE,cAAc,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,GAC/D,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC9C;;;;OAIG;IACH,oBAAoB,CAClB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C;;;;;OAKG;IACH,uCAAuC,CACrC,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,kBAAkB,GAC7B,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C;;;;OAIG;IACH,qBAAqB,CACnB,cAAc,CAAC,EAAE,cAAc,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,GAC/D,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;CAC/C,CAAC;yBAEc,OAAO,KAAK,KAAG,QAAQ;AAAvC,wBA+GE;AAEF,MAAM,WAAW,6BAA6B;IAC5C,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAAC;CACjE;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;;GAGG;AACH,wBAAgB,kCAAkC,CAAC,EACjD,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,6BAA6B,CAKhC;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,kBAAkB,EAClB,KAAK,GACN,EAAE;IACD,kBAAkB,EAAE,0BAA0B,CAAC,GAAG,CAAC,CAAC;IACpD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAS3C;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAM3C;AAED;;;;;GAKG;AACH,wBAAsB,qCAAqC,CAAC,EAC1D,YAAY,EACZ,UAAU,EACV,KAAK,GACN,EAAE;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,kBAAkB,CAAC;IAC/B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAoC3C;AAED;;;GAGG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,EAAE,CAAC,CAM7C;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAuBzC;AAED;;;;;GAKG;AACH,wBAAsB,uCAAuC,CAAC,EAC5D,YAAY,EACZ,UAAU,EACV,KAAK,GACN,EAAE;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,kBAAkB,CAAC;IAC/B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAwBzC;AAED;;;;GAIG;AACH,wBAAsB,qBAAqB,CAAC,EAC1C,OAAoC,EACpC,KAAK,GACN,EAAE;IACD,OAAO,CAAC,EAAE,2BAA2B,CAAC;IACtC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,6BAA6B,CAAC,CA4CzC;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,UAAU,EACV,kBAAkB,EAClB,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,0BAA0B,CAAC,GAAG,CAAC,CAAC;IACpD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAa3C;AAED;;;;;;;;;GASG;AACH,wBAAsB,qBAAqB,CAAC,EAC1C,UAAU,EACV,YAAY,EACZ,UAAU,EACV,UAAU,EACV,OAAoC,EACpC,cAAuB,EACvB,KAAK,GACN,EAAE;IACD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC,UAAU,EAAE,6BAA6B,CAAC;IAC1C,OAAO,CAAC,EAAE,2BAA2B,CAAC;IACtC,cAAc,CAAC,EAAE,cAAc,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAAC;IACjE,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,EAAE,CAAC,CAwD7C;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAM3C;AAED;;;;;GAKG;AACH,wBAAsB,uCAAuC,CAAC,EAC5D,YAAY,EACZ,UAAU,EACV,KAAK,GACN,EAAE;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,kBAAkB,CAAC;IAC/B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAiB3C;AAED;;;;GAIG;AACH,wBAAsB,qBAAqB,CAAC,EAC1C,cAAuB,EACvB,KAAK,GACN,EAAE;IACD,cAAc,CAAC,EAAE,cAAc,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAAC;IACjE,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,0BAA0B,CAAC,GAAG,CAAC,EAAE,CAAC,CAiB7C"}

package/types/ops/cloud/iga/IgaRequestFormOps.d.ts

@@ -0,0 +1,259 @@
+import { RequestFormAssignment, RequestFormSkeleton } from '../../../api/cloud/iga/IgaRequestFormApi';
+import { RequestTypeSkeleton } from '../../../api/cloud/iga/IgaRequestTypeApi';
+import { State } from '../../../shared/State';
+import { ExportMetaData, ResultCallback } from '../../OpsTypes';
+export type RequestForm = {
+    /**
+     * Read request form
+     * @param {string} formId The request form id
+     * @returns {Promise<RequestFormSkeleton>} a promise that resolves to a request form object
+     */
+    readRequestForm(formId: string): Promise<RequestFormSkeleton>;
+    /**
+     * Read request form by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.
+     * @param {string} formName the request form name
+     * @returns {Promise<RequestFormSkeleton>} a promise that resolves to a request form object
+     */
+    readRequestFormByName(formName: string): Promise<RequestFormSkeleton>;
+    /**
+     * Read all request forms
+     * @returns {Promise<RequestFormSkeleton[]>} a promise that resolves to an array of request form objects
+     */
+    readRequestForms(): Promise<RequestFormSkeleton[]>;
+    /**
+     * Export request form
+     * @param {string} formId the request form id
+     * @param {RequestFormExportOptions} options export options
+     * @returns {Promise<RequestFormExportInterface>} a promise that resolves to a request form export object
+     */
+    exportRequestForm(formId: string, options?: RequestFormExportOptions): Promise<RequestFormExportInterface>;
+    /**
+     * Export request form by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.
+     * @param {string} formName the request form name
+     * @param {RequestFormExportOptions} options export options
+     * @returns {Promise<RequestFormExportInterface>} a promise that resolves to a request form export object
+     */
+    exportRequestFormByName(formName: string, options?: RequestFormExportOptions): Promise<RequestFormExportInterface>;
+    /**
+     * Export all request forms
+     * @param {RequestFormExportOptions} options export options
+     * @param {ResultCallback<RequestFormExportInterface>} resultCallback Optional callback to process individual results
+     * @returns {Promise<RequestFormExportInterface>} a promise that resolves to a request form export object
+     */
+    exportRequestForms(options?: RequestFormExportOptions, resultCallback?: ResultCallback<RequestFormExportInterface>): Promise<RequestFormExportInterface>;
+    /**
+     * Update request form
+     * @param {string} formId the request form id
+     * @param {RequestFormSkeleton} formData the request form object
+     * @returns {Promise<RequestFormSkeleton>} a promise that resolves to a request form object
+     */
+    updateRequestForm(formId: string, formData: RequestFormSkeleton): Promise<RequestFormSkeleton>;
+    /**
+     * Import request forms
+     * @param {string} formId The request form id. If supplied, only the request form of that id is imported. Takes priority over formName if it is provided.
+     * @param {string} formName The request form name. If supplied, only the request form(s) of that name is imported.
+     * @param {RequestFormExportInterface} importData request form import data
+     * @param {RequestFormImportOptions} options import options
+     * @param {ResultCallback<RequestFormSkeleton>} resultCallback Optional callback to process individual results
+     * @returns {Promise<RequestFormSkeleton[]>} the imported request forms
+     */
+    importRequestForms(importData: RequestFormExportInterface, formId?: string, formName?: string, options?: RequestFormImportOptions, resultCallback?: ResultCallback<RequestFormSkeleton>): Promise<RequestFormSkeleton[]>;
+    /**
+     * Delete request form
+     * @param {string} formId the request form id
+     * @returns {Promise<RequestFormSkeleton>} a promise that resolves to a request form object
+     */
+    deleteRequestForm(formId: string): Promise<RequestFormSkeleton>;
+    /**
+     * Delete request form by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.
+     * @param {string} formName the request form name
+     * @returns {Promise<RequestFormSkeleton>} a promise that resolves to a request form object
+     */
+    deleteRequestFormByName(formName: string): Promise<RequestFormSkeleton>;
+    /**
+     * Delete request forms
+     * @param {ResultCallback} resultCallback Optional callback to process individual results
+     * @returns {Promise<RequestFormSkeleton[]>} promise that resolves to an array of request form objects
+     */
+    deleteRequestForms(resultCallback?: ResultCallback<RequestFormSkeleton>): Promise<RequestFormSkeleton[]>;
+    /**
+     * Delete orphaned request form assignments. If no ids are specified, it will remove all orphans
+     * @param {string} formId The optional request form id. If specified, deletes orphaned assignments for the specified form.
+     * @param {string} workflowId The optional workflow id. If specified, deletes orphaned assignments for the specified workflow.
+     * @param {string} applicationId The optional application id. If specified, deletes orphaned assignments for the specified application.
+     * @param {string} requestTypeId The optional request type id. If specified, deletes orphaned assignments for the specified request type.
+     * @param {boolean} onlyWorkflow Optional flag to return only workflow related assignments. Default: false
+     * @param {ResultCallback<RequestFormAssignment>} resultCallback Optional callback to process individual results
+     * @returns {RequestFormAssignment[]} the deleted orphaned form assignments
+     */
+    deleteOrphanedRequestFormAssignments(formId?: string, workflowId?: string, applicationId?: string, requestTypeId?: string, onlyWorkflow?: boolean, resultCallback?: ResultCallback<RequestFormAssignment>): Promise<RequestFormAssignment[]>;
+};
+declare const _default: (state: State) => RequestForm;
+export default _default;
+export interface RequestFormExportInterface {
+    meta?: ExportMetaData;
+    requestForm: Record<string, RequestFormSkeleton>;
+    requestType?: Record<string, RequestTypeSkeleton>;
+}
+/**
+ * Request form import options
+ */
+export interface RequestFormImportOptions {
+    /**
+     * Include any dependencies (request types).
+     */
+    deps: boolean;
+}
+/**
+ * Request form export options
+ */
+export interface RequestFormExportOptions {
+    /**
+     * Include any dependencies (request types).
+     */
+    deps: boolean;
+    /**
+     * Use string arrays to store script code
+     */
+    useStringArrays: boolean;
+}
+/**
+ * Create an empty request form export template
+ * @returns {RequestFormExportInterface} an empty request form export template
+ */
+export declare function createRequestFormExportTemplate({ state, }: {
+    state: State;
+}): RequestFormExportInterface;
+/**
+ * Read request form
+ * @param {string} formId the request form id
+ * @returns {Promise<RequestFormSkeleton>} a promise that resolves to a request form object
+ */
+export declare function readRequestForm({ formId, state, }: {
+    formId: string;
+    state: State;
+}): Promise<RequestFormSkeleton>;
+/**
+ * Read request form by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.
+ * @param {string} formName the request form name
+ * @returns {Promise<RequestFormSkeleton>} a promise that resolves to a request form object
+ */
+export declare function readRequestFormByName({ formName, state, }: {
+    formName: string;
+    state: State;
+}): Promise<RequestFormSkeleton>;
+/**
+ * Read all request forms
+ * @returns {Promise<RequestFormSkeleton[]>} a promise that resolves to an array of request form objects
+ */
+export declare function readRequestForms({ state, }: {
+    state: State;
+}): Promise<RequestFormSkeleton[]>;
+/**
+ * Export request form
+ * @param {string} formId the request form id
+ * @param {RequestFormExportOptions} options export options
+ * @returns {Promise<RequestFormExportInterface>} a promise that resolves to a request form export object
+ */
+export declare function exportRequestForm({ formId, options, state, }: {
+    formId: string;
+    options: RequestFormExportOptions;
+    state: State;
+}): Promise<RequestFormExportInterface>;
+/**
+ * Export request form by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.
+ * @param {string} formName the request form name
+ * @param {RequestFormExportOptions} options export options
+ * @returns {Promise<RequestFormExportInterface>} a promise that resolves to a request form export object
+ */
+export declare function exportRequestFormByName({ formName, options, state, }: {
+    formName: string;
+    options?: RequestFormExportOptions;
+    state: State;
+}): Promise<RequestFormExportInterface>;
+/**
+ * Export all request forms
+ * @param {RequestFormExportOptions} options export options
+ * @param {ResultCallback} resultCallback Optional callback to process individual results
+ * @returns {Promise<RequestFormExportInterface>} a promise that resolves to a request form export object
+ */
+export declare function exportRequestForms({ options, resultCallback, state, }: {
+    options?: RequestFormExportOptions;
+    resultCallback?: ResultCallback<RequestFormExportInterface>;
+    state: State;
+}): Promise<RequestFormExportInterface>;
+/**
+ * Update request form
+ * @param {string} formId the request form id
+ * @param {RequestFormSkeleton} formData the request form object
+ * @returns {Promise<RequestFormSkeleton>} a promise that resolves to a request form object
+ */
+export declare function updateRequestForm({ formId, formData, state, }: {
+    formId: string;
+    formData: RequestFormSkeleton;
+    state: State;
+}): Promise<RequestFormSkeleton>;
+/**
+ * Import request forms
+ * @param {string} formId The request form id. If supplied, only the request form of that id is imported. Takes priority over formName if it is provided.
+ * @param {string} formName The request form name. If supplied, only the request form(s) of that name is imported.
+ * @param {RequestFormExportInterface} importData request form import data
+ * @param {RequestFormImportOptions} options import options
+ * @param {ResultCallback<RequestFormSkeleton>} resultCallback Optional callback to process individual results
+ * @returns {Promise<RequestFormSkeleton[]>} the imported request forms
+ */
+export declare function importRequestForms({ formId, formName, importData, options, resultCallback, state, }: {
+    formId?: string;
+    formName?: string;
+    importData: RequestFormExportInterface;
+    options?: RequestFormImportOptions;
+    resultCallback?: ResultCallback<RequestFormSkeleton>;
+    state: State;
+}): Promise<RequestFormSkeleton[]>;
+/**
+ * Delete request form
+ * @param {string} formId the request form id
+ * @returns {Promise<RequestFormSkeleton>} a promise that resolves to a request form object
+ */
+export declare function deleteRequestForm({ formId, state, }: {
+    formId: string;
+    state: State;
+}): Promise<RequestFormSkeleton>;
+/**
+ * Delete request form by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.
+ * @param {string} formName the request form name
+ * @returns {Promise<RequestFormSkeleton>} a promise that resolves to a request form object
+ */
+export declare function deleteRequestFormByName({ formName, state, }: {
+    formName: string;
+    state: State;
+}): Promise<RequestFormSkeleton>;
+/**
+ * Delete request forms
+ * @param {ResultCallback} resultCallback Optional callback to process individual results
+ * @returns {Promise<RequestFormSkeleton[]>} promise that resolves to an array of request form objects
+ */
+export declare function deleteRequestForms({ resultCallback, state, }: {
+    resultCallback?: ResultCallback<RequestFormSkeleton>;
+    state: State;
+}): Promise<RequestFormSkeleton[]>;
+/**
+ * Delete orphaned request form assignments. If no ids are specified, it will remove all orphans
+ * @param {string} formId The optional request form id. If specified, deletes orphaned assignments for the specified form.
+ * @param {string} workflowId The optional workflow id. If specified, deletes orphaned assignments for the specified workflow.
+ * @param {string} applicationId The optional application id. If specified, deletes orphaned assignments for the specified application.
+ * @param {string} requestTypeId The optional request type id. If specified, deletes orphaned assignments for the specified request type.
+ * @param {boolean} onlyWorkflow Optional flag to return only workflow related assignments. Default: false
+ * @param {ResultCallback<RequestFormAssignment>} resultCallback Optional callback to process individual results
+ * @returns {RequestFormAssignment[]} the deleted orphaned form assignments
+ */
+export declare function deleteOrphanedRequestFormAssignments({ formId, workflowId, applicationId, requestTypeId, onlyWorkflow, resultCallback, state, }: {
+    formId?: string;
+    workflowId?: string;
+    applicationId?: string;
+    requestTypeId?: string;
+    onlyWorkflow?: boolean;
+    resultCallback?: ResultCallback<RequestFormAssignment>;
+    state: State;
+}): Promise<RequestFormAssignment[]>;
+//# sourceMappingURL=IgaRequestFormOps.d.ts.map

package/types/ops/cloud/iga/IgaRequestFormOps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IgaRequestFormOps.d.ts","sourceRoot":"","sources":["../../../../src/ops/cloud/iga/IgaRequestFormOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,qBAAqB,EACrB,mBAAmB,EAEpB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAEL,mBAAmB,EACpB,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAe9C,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAIhE,MAAM,MAAM,WAAW,GAAG;IACxB;;;;OAIG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC9D;;;;OAIG;IACH,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACtE;;;OAGG;IACH,gBAAgB,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACnD;;;;;OAKG;IACH,iBAAiB,CACf,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,0BAA0B,CAAC,CAAC;IACvC;;;;;OAKG;IACH,uBAAuB,CACrB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,0BAA0B,CAAC,CAAC;IACvC;;;;;OAKG;IACH,kBAAkB,CAChB,OAAO,CAAC,EAAE,wBAAwB,EAClC,cAAc,CAAC,EAAE,cAAc,CAAC,0BAA0B,CAAC,GAC1D,OAAO,CAAC,0BAA0B,CAAC,CAAC;IACvC;;;;;OAKG;IACH,iBAAiB,CACf,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,mBAAmB,GAC5B,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChC;;;;;;;;OAQG;IACH,kBAAkB,CAChB,UAAU,EAAE,0BAA0B,EACtC,MAAM,CAAC,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,wBAAwB,EAClC,cAAc,CAAC,EAAE,cAAc,CAAC,mBAAmB,CAAC,GACnD,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAClC;;;;OAIG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChE;;;;OAIG;IACH,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACxE;;;;OAIG;IACH,kBAAkB,CAChB,cAAc,CAAC,EAAE,cAAc,CAAC,mBAAmB,CAAC,GACnD,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAClC;;;;;;;;;OASG;IACH,oCAAoC,CAClC,MAAM,CAAC,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,EACnB,aAAa,CAAC,EAAE,MAAM,EACtB,aAAa,CAAC,EAAE,MAAM,EACtB,YAAY,CAAC,EAAE,OAAO,EACtB,cAAc,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC,GACrD,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC;CACrC,CAAC;yBAEc,OAAO,KAAK,KAAG,WAAW;AAA1C,wBAkHE;AAEF,MAAM,WAAW,0BAA0B;IACzC,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACjD,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAAC,EAC9C,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,0BAA0B,CAM7B;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,EACpC,MAAM,EACN,KAAK,GACN,EAAE;IACD,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAM/B;AAED;;;;GAIG;AACH,wBAAsB,qBAAqB,CAAC,EAC1C,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAe/B;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAMjC;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,MAAM,EACN,OAA+C,EAC/C,KAAK,GACN,EAAE;IACD,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,wBAAwB,CAAC;IAClC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAuBtC;AAED;;;;;GAKG;AACH,wBAAsB,uBAAuB,CAAC,EAC5C,QAAQ,EACR,OAA+C,EAC/C,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,wBAAwB,CAAC;IACnC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAuBtC;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,OAA+C,EAC/C,cAAuB,EACvB,KAAK,GACN,EAAE;IACD,OAAO,CAAC,EAAE,wBAAwB,CAAC;IACnC,cAAc,CAAC,EAAE,cAAc,CAAC,0BAA0B,CAAC,CAAC;IAC5D,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAuDtC;AAED;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,MAAM,EACN,QAAQ,EACR,KAAK,GACN,EAAE;IACD,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAa/B;AAED;;;;;;;;GAQG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,MAAM,EACN,QAAQ,EACR,UAAU,EACV,OAAwB,EACxB,cAAuB,EACvB,KAAK,GACN,EAAE;IACD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,0BAA0B,CAAC;IACvC,OAAO,CAAC,EAAE,wBAAwB,CAAC;IACnC,cAAc,CAAC,EAAE,cAAc,CAAC,mBAAmB,CAAC,CAAC;IACrD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CA0EjC;AAED;;;;GAIG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,MAAM,EACN,KAAK,GACN,EAAE;IACD,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAiB/B;AAED;;;;GAIG;AACH,wBAAsB,uBAAuB,CAAC,EAC5C,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAa/B;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,cAAuB,EACvB,KAAK,GACN,EAAE;IACD,cAAc,CAAC,EAAE,cAAc,CAAC,mBAAmB,CAAC,CAAC;IACrD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAejC;AAED;;;;;;;;;GASG;AACH,wBAAsB,oCAAoC,CAAC,EACzD,MAAM,EACN,UAAU,EACV,aAAa,EACb,aAAa,EACb,YAAoB,EACpB,cAAuB,EACvB,KAAK,GACN,EAAE;IACD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,cAAc,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC,CAAC;IACvD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC,CA8EnC"}