@rockcarver/frodo-lib 4.10.0 → 4.11.0-1

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

@@ -0,0 +1,261 @@
+import { CertificationTemplateDeleteSkeleton, CertificationTemplateSkeleton } from '../../../api/cloud/iga/IgaCertificationTemplateApi';
+import { VariableSkeleton } from '../../../api/cloud/VariablesApi';
+import { State } from '../../../shared/State';
+import { EmailTemplateSkeleton } from '../../EmailTemplateOps';
+import { ExportMetaData, ResultCallback } from '../../OpsTypes';
+export type CertificationTemplate = {
+    /**
+     * Create certification template
+     * @param {CertificationTemplateSkeleton} templateData the certification template object
+     * @returns {Promise<CertificationTemplateSkeleton>} a promise that resolves to a certification template object
+     */
+    createCertificationTemplate(templateData: CertificationTemplateSkeleton): Promise<CertificationTemplateSkeleton>;
+    /**
+     * Read certification template
+     * @param {string} templateId The certification template id
+     * @returns {Promise<CertificationTemplateSkeleton>} a promise that resolves to a certification template object
+     */
+    readCertificationTemplate(templateId: string): Promise<CertificationTemplateSkeleton>;
+    /**
+     * Read certification template by its name.
+     * @param {string} templateName the certification template name
+     * @returns {Promise<CertificationTemplateSkeleton>} a promise that resolves to a certification template object
+     */
+    readCertificationTemplateByName(templateName: string): Promise<CertificationTemplateSkeleton>;
+    /**
+     * Read all certification templates
+     * @param {boolean} includeEventTemplates True to also include certification templates used in IGA events, false otherwise. Default: false
+     * @returns {Promise<CertificationTemplateSkeleton[]>} a promise that resolves to an array of certification template objects
+     */
+    readCertificationTemplates(includeEventTemplates?: boolean): Promise<CertificationTemplateSkeleton[]>;
+    /**
+     * Export certification template
+     * @param {string} templateId the certification template id
+     * @param {CertificationTemplateExportOptions} options export options
+     * @returns {Promise<CertificationTemplateExportInterface>} a promise that resolves to a certification template export object
+     */
+    exportCertificationTemplate(templateId: string, options?: CertificationTemplateExportOptions): Promise<CertificationTemplateExportInterface>;
+    /**
+     * Export certification template by its name.
+     * @param {string} templateName the certification template name
+     * @param {CertificationTemplateExportOptions} options export options
+     * @returns {Promise<CertificationTemplateExportInterface>} a promise that resolves to a certification template export object
+     */
+    exportCertificationTemplateByName(templateName: string, options?: CertificationTemplateExportOptions): Promise<CertificationTemplateExportInterface>;
+    /**
+     * Export all certification templates
+     * @param {CertificationTemplateExportOptions} options export options
+     * @param {ResultCallback<CertificationTemplateExportInterface>} resultCallback Optional callback to process individual results
+     * @returns {Promise<CertificationTemplateExportInterface>} a promise that resolves to a certification template export object
+     */
+    exportCertificationTemplates(options?: CertificationTemplateExportOptions, resultCallback?: ResultCallback<CertificationTemplateExportInterface>): Promise<CertificationTemplateExportInterface>;
+    /**
+     * Update certification template
+     * @param {string} templateId the certification template id
+     * @param {CertificationTemplateSkeleton} templateData the certification template object
+     * @returns {Promise<CertificationTemplateSkeleton>} a promise that resolves to a certification template object
+     */
+    updateCertificationTemplate(templateId: string, templateData: CertificationTemplateSkeleton): Promise<CertificationTemplateSkeleton>;
+    /**
+     * Import certification templates
+     * @param {string} templateId The certification template id. If supplied, only the certification template of that id is imported. Takes priority over templateName if it is provided.
+     * @param {string} templateName The certification template name. If supplied, only the certification template of that name is imported.
+     * @param {CertificationTemplateExportInterface} importData certification template import data
+     * @param {CertificationTemplateImportOptions} options import options
+     * @param {ResultCallback<CertificationTemplateSkeleton>} resultCallback Optional callback to process individual results
+     * @returns {Promise<CertificationTemplateSkeleton[]>} the imported certification templates
+     */
+    importCertificationTemplates(importData: CertificationTemplateExportInterface, templateId?: string, templateName?: string, options?: CertificationTemplateImportOptions, resultCallback?: ResultCallback<CertificationTemplateSkeleton>): Promise<CertificationTemplateSkeleton[]>;
+    /**
+     * Delete certification template
+     * @param {string} templateId the certification template id
+     * @returns {Promise<CertificationTemplateDeleteSkeleton>} a promise that resolves to a certification template object
+     */
+    deleteCertificationTemplate(templateId: string): Promise<CertificationTemplateDeleteSkeleton>;
+    /**
+     * Delete certification template by its name.
+     * @param {string} templateName the certification template name
+     * @returns {Promise<CertificationTemplateDeleteSkeleton>} a promise that resolves to a certification template object
+     */
+    deleteCertificationTemplateByName(templateName: string): Promise<CertificationTemplateDeleteSkeleton>;
+    /**
+     * Delete certification templates
+     * @param {CertificationTemplateDeleteOptions} options delete options
+     * @param {ResultCallback} resultCallback Optional callback to process individual results
+     * @returns {Promise<CertificationTemplateDeleteSkeleton[]>} promise that resolves to an array of certification template objects
+     */
+    deleteCertificationTemplates(options?: CertificationTemplateDeleteOptions, resultCallback?: ResultCallback<CertificationTemplateDeleteSkeleton>): Promise<CertificationTemplateDeleteSkeleton[]>;
+};
+declare const _default: (state: State) => CertificationTemplate;
+export default _default;
+export interface CertificationTemplateExportInterface {
+    meta?: ExportMetaData;
+    certificationTemplate: Record<string, CertificationTemplateSkeleton>;
+    emailTemplate?: Record<string, EmailTemplateSkeleton>;
+    variable: Record<string, VariableSkeleton>;
+}
+/**
+ * Certification template import options
+ */
+export interface CertificationTemplateImportOptions {
+    /**
+     * Include any dependencies (email templates).
+     */
+    deps: boolean;
+}
+/**
+ * Certification template export options
+ */
+export interface CertificationTemplateExportOptions {
+    /**
+     * Include any dependencies (email templates).
+     */
+    deps: boolean;
+    /**
+     * Export certification templates that are tied to IGA events in addition to the normal certification templates
+     */
+    includeEventTemplates: boolean;
+}
+/**
+ * Certification template delete options
+ */
+export interface CertificationTemplateDeleteOptions {
+    /**
+     * Delete certification templates that are tied to IGA events in addition to the normal certification templates
+     */
+    includeEventTemplates: boolean;
+}
+/**
+ * Create an empty certification template export template
+ * @returns {CertificationTemplateExportInterface} an empty certification template export template
+ */
+export declare function createCertificationTemplateExportTemplate({ state, }: {
+    state: State;
+}): CertificationTemplateExportInterface;
+/**
+ * Create certification template
+ * @param {CertificationTemplateSkeleton} templateData the certification template object
+ * @returns {Promise<CertificationTemplateSkeleton>} a promise that resolves to a certification template object
+ */
+export declare function createCertificationTemplate({ templateData, state, }: {
+    templateData: CertificationTemplateSkeleton;
+    state: State;
+}): Promise<CertificationTemplateSkeleton>;
+/**
+ * Read certification template
+ * @param {string} templateId the certification template id
+ * @returns {Promise<CertificationTemplateSkeleton>} a promise that resolves to a certification template object
+ */
+export declare function readCertificationTemplate({ templateId, state, }: {
+    templateId: string;
+    state: State;
+}): Promise<CertificationTemplateSkeleton>;
+/**
+ * Read certification template by its name.
+ * @param {string} templateName the certification template name
+ * @returns {Promise<CertificationTemplateSkeleton>} a promise that resolves to a certification template object
+ */
+export declare function readCertificationTemplateByName({ templateName, state, }: {
+    templateName: string;
+    state: State;
+}): Promise<CertificationTemplateSkeleton>;
+/**
+ * Read all certification templates
+ * @param {boolean} includeEventTemplates True to also include certification templates used in IGA events, false otherwise. Default: false
+ * @returns {Promise<CertificationTemplateSkeleton[]>} a promise that resolves to an array of certification template objects
+ */
+export declare function readCertificationTemplates({ includeEventTemplates, state, }: {
+    includeEventTemplates?: boolean;
+    state: State;
+}): Promise<CertificationTemplateSkeleton[]>;
+/**
+ * Export certification template
+ * @param {string} templateId the certification template id
+ * @param {CertificationTemplateExportOptions} options export options
+ * @returns {Promise<CertificationTemplateExportInterface>} a promise that resolves to a certification template export object
+ */
+export declare function exportCertificationTemplate({ templateId, options, state, }: {
+    templateId: string;
+    options: CertificationTemplateExportOptions;
+    state: State;
+}): Promise<CertificationTemplateExportInterface>;
+/**
+ * Export certification template by its name.
+ * @param {string} templateName the certification template name
+ * @param {CertificationTemplateExportOptions} options export options
+ * @returns {Promise<CertificationTemplateExportInterface>} a promise that resolves to a certification template export object
+ */
+export declare function exportCertificationTemplateByName({ templateName, options, state, }: {
+    templateName: string;
+    options?: CertificationTemplateExportOptions;
+    state: State;
+}): Promise<CertificationTemplateExportInterface>;
+/**
+ * Export all certification templates
+ * @param {CertificationTemplateExportOptions} options export options
+ * @param {ResultCallback} resultCallback Optional callback to process individual results
+ * @returns {Promise<CertificationTemplateExportInterface>} a promise that resolves to a certification template export object
+ */
+export declare function exportCertificationTemplates({ options, resultCallback, state, }: {
+    options?: CertificationTemplateExportOptions;
+    resultCallback?: ResultCallback<CertificationTemplateExportInterface>;
+    state: State;
+}): Promise<CertificationTemplateExportInterface>;
+/**
+ * Update certification template
+ * @param {string} templateId the certification template id
+ * @param {CertificationTemplateSkeleton} templateData the certification template object
+ * @returns {Promise<CertificationTemplateSkeleton>} a promise that resolves to a certification template object
+ */
+export declare function updateCertificationTemplate({ templateId, templateData, state, }: {
+    templateId: string;
+    templateData: CertificationTemplateSkeleton;
+    state: State;
+}): Promise<CertificationTemplateSkeleton>;
+/**
+ * Import certification templates
+ * @param {string} templateId The certification template id. If supplied, only the certification template of that id is imported. Takes priority over templateName if it is provided.
+ * @param {string} templateName The certification template name. If supplied, only the certification template(s) of that name is imported.
+ * @param {CertificationTemplateExportInterface} importData certification template import data
+ * @param {CertificationTemplateImportOptions} options import options
+ * @param {ResultCallback<CertificationTemplateSkeleton>} resultCallback Optional callback to process individual results
+ * @returns {Promise<CertificationTemplateSkeleton[]>} the imported certification templates
+ */
+export declare function importCertificationTemplates({ templateId, templateName, importData, options, resultCallback, state, }: {
+    templateId?: string;
+    templateName?: string;
+    importData: CertificationTemplateExportInterface;
+    options?: CertificationTemplateImportOptions;
+    resultCallback?: ResultCallback<CertificationTemplateSkeleton>;
+    state: State;
+}): Promise<CertificationTemplateSkeleton[]>;
+/**
+ * Delete certification template
+ * @param {string} templateId the certification template id
+ * @returns {Promise<CertificationTemplateDeleteSkeleton>} a promise that resolves to a certification template object
+ */
+export declare function deleteCertificationTemplate({ templateId, state, }: {
+    templateId: string;
+    state: State;
+}): Promise<CertificationTemplateDeleteSkeleton>;
+/**
+ * Delete certification template by its name.
+ * @param {string} templateName the certification template name
+ * @returns {Promise<CertificationTemplateDeleteSkeleton>} a promise that resolves to a certification template object
+ */
+export declare function deleteCertificationTemplateByName({ templateName, state, }: {
+    templateName: string;
+    state: State;
+}): Promise<CertificationTemplateDeleteSkeleton>;
+/**
+ * Delete certification templates
+ * @param {CertificationTemplateDeleteOptions} options delete options
+ * @param {ResultCallback} resultCallback Optional callback to process individual results
+ * @returns {Promise<CertificationTemplateDeleteSkeleton[]>} promise that resolves to an array of certification template objects
+ */
+export declare function deleteCertificationTemplates({ options, resultCallback, state, }: {
+    options: CertificationTemplateDeleteOptions;
+    resultCallback?: ResultCallback<CertificationTemplateDeleteSkeleton>;
+    state: State;
+}): Promise<CertificationTemplateDeleteSkeleton[]>;
+//# sourceMappingURL=IgaCertificationTemplateOps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IgaCertificationTemplateOps.d.ts","sourceRoot":"","sources":["../../../../src/ops/cloud/iga/IgaCertificationTemplateOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,mCAAmC,EACnC,6BAA6B,EAK9B,MAAM,oDAAoD,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAa9C,OAAO,EACL,qBAAqB,EAEtB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhE,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;OAIG;IACH,2BAA2B,CACzB,YAAY,EAAE,6BAA6B,GAC1C,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC1C;;;;OAIG;IACH,yBAAyB,CACvB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC1C;;;;OAIG;IACH,+BAA+B,CAC7B,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC1C;;;;OAIG;IACH,0BAA0B,CACxB,qBAAqB,CAAC,EAAE,OAAO,GAC9B,OAAO,CAAC,6BAA6B,EAAE,CAAC,CAAC;IAC5C;;;;;OAKG;IACH,2BAA2B,CACzB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,kCAAkC,GAC3C,OAAO,CAAC,oCAAoC,CAAC,CAAC;IACjD;;;;;OAKG;IACH,iCAAiC,CAC/B,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,kCAAkC,GAC3C,OAAO,CAAC,oCAAoC,CAAC,CAAC;IACjD;;;;;OAKG;IACH,4BAA4B,CAC1B,OAAO,CAAC,EAAE,kCAAkC,EAC5C,cAAc,CAAC,EAAE,cAAc,CAAC,oCAAoC,CAAC,GACpE,OAAO,CAAC,oCAAoC,CAAC,CAAC;IACjD;;;;;OAKG;IACH,2BAA2B,CACzB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,6BAA6B,GAC1C,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC1C;;;;;;;;OAQG;IACH,4BAA4B,CAC1B,UAAU,EAAE,oCAAoC,EAChD,UAAU,CAAC,EAAE,MAAM,EACnB,YAAY,CAAC,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,kCAAkC,EAC5C,cAAc,CAAC,EAAE,cAAc,CAAC,6BAA6B,CAAC,GAC7D,OAAO,CAAC,6BAA6B,EAAE,CAAC,CAAC;IAC5C;;;;OAIG;IACH,2BAA2B,CACzB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,mCAAmC,CAAC,CAAC;IAChD;;;;OAIG;IACH,iCAAiC,CAC/B,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,mCAAmC,CAAC,CAAC;IAChD;;;;;OAKG;IACH,4BAA4B,CAC1B,OAAO,CAAC,EAAE,kCAAkC,EAC5C,cAAc,CAAC,EAAE,cAAc,CAAC,mCAAmC,CAAC,GACnE,OAAO,CAAC,mCAAmC,EAAE,CAAC,CAAC;CACnD,CAAC;yBAEc,OAAO,KAAK,KAAG,qBAAqB;AAApD,wBAgIE;AAEF,MAAM,WAAW,oCAAoC;IACnD,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;IACrE,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACtD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;CAChC;AAED;;;GAGG;AACH,wBAAgB,yCAAyC,CAAC,EACxD,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,oCAAoC,CAOvC;AAED;;;;GAIG;AACH,wBAAsB,2BAA2B,CAAC,EAChD,YAAY,EACZ,KAAK,GACN,EAAE;IACD,YAAY,EAAE,6BAA6B,CAAC;IAC5C,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,6BAA6B,CAAC,CASzC;AAED;;;;GAIG;AACH,wBAAsB,yBAAyB,CAAC,EAC9C,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,6BAA6B,CAAC,CASzC;AAED;;;;GAIG;AACH,wBAAsB,+BAA+B,CAAC,EACpD,YAAY,EACZ,KAAK,GACN,EAAE;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAwBzC;AAED;;;;GAIG;AACH,wBAAsB,0BAA0B,CAAC,EAC/C,qBAA6B,EAC7B,KAAK,GACN,EAAE;IACD,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,6BAA6B,EAAE,CAAC,CAU3C;AAED;;;;;GAKG;AACH,wBAAsB,2BAA2B,CAAC,EAChD,UAAU,EACV,OAAsD,EACtD,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,kCAAkC,CAAC;IAC5C,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oCAAoC,CAAC,CA0BhD;AAED;;;;;GAKG;AACH,wBAAsB,iCAAiC,CAAC,EACtD,YAAY,EACZ,OAAsD,EACtD,KAAK,GACN,EAAE;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,kCAAkC,CAAC;IAC7C,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oCAAoC,CAAC,CA0BhD;AAED;;;;;GAKG;AACH,wBAAsB,4BAA4B,CAAC,EACjD,OAAsD,EACtD,cAAuB,EACvB,KAAK,GACN,EAAE;IACD,OAAO,CAAC,EAAE,kCAAkC,CAAC;IAC7C,cAAc,CAAC,EAAE,cAAc,CAAC,oCAAoC,CAAC,CAAC;IACtE,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oCAAoC,CAAC,CA8DhD;AAED;;;;;GAKG;AACH,wBAAsB,2BAA2B,CAAC,EAChD,UAAU,EACV,YAAY,EACZ,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,6BAA6B,CAAC;IAC5C,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAazC;AAED;;;;;;;;GAQG;AACH,wBAAsB,4BAA4B,CAAC,EACjD,UAAU,EACV,YAAY,EACZ,UAAU,EACV,OAAwB,EACxB,cAAuB,EACvB,KAAK,GACN,EAAE;IACD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,oCAAoC,CAAC;IACjD,OAAO,CAAC,EAAE,kCAAkC,CAAC;IAC7C,cAAc,CAAC,EAAE,cAAc,CAAC,6BAA6B,CAAC,CAAC;IAC/D,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,6BAA6B,EAAE,CAAC,CAwF3C;AAED;;;;GAIG;AACH,wBAAsB,2BAA2B,CAAC,EAChD,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mCAAmC,CAAC,CAS/C;AAED;;;;GAIG;AACH,wBAAsB,iCAAiC,CAAC,EACtD,YAAY,EACZ,KAAK,GACN,EAAE;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mCAAmC,CAAC,CAgB/C;AAED;;;;;GAKG;AACH,wBAAsB,4BAA4B,CAAC,EACjD,OAEC,EACD,cAAuB,EACvB,KAAK,GACN,EAAE;IACD,OAAO,EAAE,kCAAkC,CAAC;IAC5C,cAAc,CAAC,EAAE,cAAc,CAAC,mCAAmC,CAAC,CAAC;IACrE,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mCAAmC,EAAE,CAAC,CAkBjD"}

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

@@ -0,0 +1,242 @@
+import { EventSkeleton } from '../../../api/cloud/iga/IgaEventApi';
+import { VariableSkeleton } from '../../../api/cloud/VariablesApi';
+import { State } from '../../../shared/State';
+import { EmailTemplateSkeleton } from '../../EmailTemplateOps';
+import { ExportMetaData, ResultCallback } from '../../OpsTypes';
+export type IgaEvent = {
+    /**
+     * Create event
+     * @param {EventSkeleton} eventData the event object
+     * @returns {Promise<EventSkeleton>} a promise that resolves to an event object
+     */
+    createEvent(eventData: EventSkeleton): Promise<EventSkeleton>;
+    /**
+     * Read Event
+     * @param {string} eventId The event id
+     * @returns {Promise<EventSkeleton>} A promise that resolves to a event object
+     */
+    readEvent(eventId: string): Promise<EventSkeleton>;
+    /**
+     * Read event by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.
+     * @param {string} eventName the event name
+     * @returns {Promise<EventSkeleton>} a promise that resolves to a event object
+     */
+    readEventByName(eventName: string): Promise<EventSkeleton>;
+    /**
+     * Read all events
+     * @returns {Promise<EventSkeleton[]>} a promise that resolves to an array of event objects
+     */
+    readEvents(): Promise<EventSkeleton[]>;
+    /**
+     * Export event
+     * @param {string} eventId The event id
+     * @param {EventExportOptions} options Export options
+     * @returns {Promise<EventExportInterface>} A promise that resolves to a event export object
+     */
+    exportEvent(eventId: string, options?: EventExportOptions): Promise<EventExportInterface>;
+    /**
+     * Export event by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.
+     * @param {string} eventName the event name
+     * @param {EventExportOptions} options export options
+     * @returns {Promise<EventExportInterface>} a promise that resolves to a event export object
+     */
+    exportEventByName(eventName: string, options?: EventExportOptions): Promise<EventExportInterface>;
+    /**
+     * Export all events
+     * @param {EventExportOptions} options Export options
+     * @param {ResultCallback<EventExportInterface>} resultCallback Optional callback to process individual results
+     * @returns {Promise<EventExportInterface>} A promise that resolves to a event export object
+     */
+    exportEvents(options?: EventExportOptions, resultCallback?: ResultCallback<EventExportInterface>): Promise<EventExportInterface>;
+    /**
+     * Update event
+     * @param {string} eventId The event id
+     * @param {EventSkeleton} eventData The event object
+     * @returns {Promise<EventSkeleton>} A promise that resolves to a event object
+     */
+    updateEvent(eventId: string, eventData: EventSkeleton): Promise<EventSkeleton>;
+    /**
+     * Import events
+     * @param {string} eventId The event id. If supplied, only the event of that id is imported. Takes priority over eventName if it is provided.
+     * @param {string} eventName The event name. If supplied, only the event(s) of that name is imported.
+     * @param {EventExportInterface} importData Event import data
+     * @param {EventImportOptions} options Import options
+     * @param {ResultCallback<EventSkeleton>} resultCallback Optional callback to process individual results
+     * @returns {Promise<EventSkeleton[]>} The imported events
+     */
+    importEvents(importData: EventExportInterface, eventId?: string, eventName?: string, options?: EventImportOptions, resultCallback?: ResultCallback<EventSkeleton>): Promise<EventSkeleton[]>;
+    /**
+     * Delete event
+     * @param {string} eventId The event id
+     * @returns {Promise<EventSkeleton>} A promise that resolves to a event object
+     */
+    deleteEvent(eventId: string): Promise<EventSkeleton>;
+    /**
+     * Delete event by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.
+     * @param {string} eventName The event name
+     * @returns {Promise<EventSkeleton>} A promise that resolves to a event object
+     */
+    deleteEventByName(eventName: string): Promise<EventSkeleton>;
+    /**
+     * Delete events
+     * @param {ResultCallback} resultCallback Optional callback to process individual results
+     * @returns {Promise<EventSkeleton[]>} A promise that resolves to an array of event objects
+     */
+    deleteEvents(resultCallback?: ResultCallback<EventSkeleton>): Promise<EventSkeleton[]>;
+};
+declare const _default: (state: State) => IgaEvent;
+export default _default;
+export interface EventExportInterface {
+    meta?: ExportMetaData;
+    event: Record<string, EventSkeleton>;
+    emailTemplate?: Record<string, EmailTemplateSkeleton>;
+    variable: Record<string, VariableSkeleton>;
+}
+/**
+ * Event import options
+ */
+export interface EventImportOptions {
+    /**
+     * Include any dependencies (e.g. email templates).
+     */
+    deps: boolean;
+}
+/**
+ * Event export options
+ */
+export interface EventExportOptions {
+    /**
+     * Include any dependencies (e.g. email templates).
+     */
+    deps: boolean;
+}
+/**
+ * Create an empty event export template
+ * @returns {EventExportInterface} an empty event export template
+ */
+export declare function createEventExportTemplate({ state, }: {
+    state: State;
+}): EventExportInterface;
+/**
+ * Create event
+ * @param {EventSkeleton} eventData the event object
+ * @returns {Promise<EventSkeleton>} a promise that resolves to an event object
+ */
+export declare function createEvent({ eventData, state, }: {
+    eventData: EventSkeleton;
+    state: State;
+}): Promise<EventSkeleton>;
+/**
+ * Read Event
+ * @param {string} eventId The event id
+ * @returns {Promise<EventSkeleton>} A promise that resoves to a event object
+ */
+export declare function readEvent({ eventId, state, }: {
+    eventId: string;
+    state: State;
+}): Promise<EventSkeleton>;
+/**
+ * Read event by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.
+ * @param {string} eventName the event name
+ * @returns {Promise<EventSkeleton>} a promise that resolves to a event object
+ */
+export declare function readEventByName({ eventName, state, }: {
+    eventName: string;
+    state: State;
+}): Promise<EventSkeleton>;
+/**
+ * Read all events
+ * @returns {Promise<EventSkeleton[]>} a promise that resolves to an array of event objects
+ */
+export declare function readEvents({ state, }: {
+    state: State;
+}): Promise<EventSkeleton[]>;
+/**
+ * Export event
+ * @param {string} eventId the event id
+ * @param {EventExportOptions} options export options
+ * @returns {Promise<EventExportInterface>} a promise that resolves to a event export object
+ */
+export declare function exportEvent({ eventId, options, state, }: {
+    eventId: string;
+    options: EventExportOptions;
+    state: State;
+}): Promise<EventExportInterface>;
+/**
+ * Export event by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.
+ * @param {string} eventName the event name
+ * @param {EventExportOptions} options export options
+ * @returns {Promise<EventExportInterface>} a promise that resolves to a event export object
+ */
+export declare function exportEventByName({ eventName, options, state, }: {
+    eventName: string;
+    options?: EventExportOptions;
+    state: State;
+}): Promise<EventExportInterface>;
+/**
+ * Export all events
+ * @param {EventExportOptions} options Export options
+ * @param {ResultCallback} resultCallback Optional callback to process individual results
+ * @returns {Promise<EventExportInterface>} a promise that resolves to a event export object
+ */
+export declare function exportEvents({ options, resultCallback, state, }: {
+    options?: EventExportOptions;
+    resultCallback?: ResultCallback<EventExportInterface>;
+    state: State;
+}): Promise<EventExportInterface>;
+/**
+ * Update event
+ * @param {string} eventId the event id
+ * @param {EventSkeleton} eventData the event object
+ * @returns {Promise<EventSkeleton>} a promise that resolves to a event object
+ */
+export declare function updateEvent({ eventId, eventData, state, }: {
+    eventId: string;
+    eventData: EventSkeleton;
+    state: State;
+}): Promise<EventSkeleton>;
+/**
+ * Import events
+ * @param {string} eventId The event id. If supplied, only the event of that id is imported. Takes priority over eventName if it is provided.
+ * @param {string} eventName The event name. If supplied, only the event(s) of that name is imported.
+ * @param {EventExportInterface} importData event import data
+ * @param {EventImportOptions} options import options
+ * @param {ResultCallback<EventSkeleton>} resultCallback Optional callback to process individual results
+ * @returns {Promise<EventSkeleton[]>} the imported events
+ */
+export declare function importEvents({ eventId, eventName, importData, options, resultCallback, state, }: {
+    eventId?: string;
+    eventName?: string;
+    importData: EventExportInterface;
+    options?: EventImportOptions;
+    resultCallback?: ResultCallback<EventSkeleton>;
+    state: State;
+}): Promise<EventSkeleton[]>;
+/**
+ * Delete event
+ * @param {string} eventId the event id
+ * @returns {Promise<EventSkeleton>} a promise that resolves to a event object
+ */
+export declare function deleteEvent({ eventId, state, }: {
+    eventId: string;
+    state: State;
+}): Promise<EventSkeleton>;
+/**
+ * Delete event by its name. Since names are NOT necessarily unique, this method will throw if it finds multiple of the same name.
+ * @param {string} eventName the event name
+ * @returns {Promise<EventSkeleton>} a promise that resolves to a event object
+ */
+export declare function deleteEventByName({ eventName, state, }: {
+    eventName: string;
+    state: State;
+}): Promise<EventSkeleton>;
+/**
+ * Delete events
+ * @param {ResultCallback} resultCallback Optional callback to process individual results
+ * @returns {Promise<EventSkeleton[]>} promise that resolves to an array of event objects
+ */
+export declare function deleteEvents({ resultCallback, state, }: {
+    resultCallback?: ResultCallback<EventSkeleton>;
+    state: State;
+}): Promise<EventSkeleton[]>;
+//# sourceMappingURL=IgaEventOps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IgaEventOps.d.ts","sourceRoot":"","sources":["../../../../src/ops/cloud/iga/IgaEventOps.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,aAAa,EAId,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAa9C,OAAO,EACL,qBAAqB,EAEtB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhE,MAAM,MAAM,QAAQ,GAAG;IACrB;;;;OAIG;IACH,WAAW,CAAC,SAAS,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC9D;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACnD;;;;OAIG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC3D;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IACvC;;;;;OAKG;IACH,WAAW,CACT,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,kBAAkB,GAC3B,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC;;;;;OAKG;IACH,iBAAiB,CACf,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC;;;;;OAKG;IACH,YAAY,CACV,OAAO,CAAC,EAAE,kBAAkB,EAC5B,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,CAAC,GACpD,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC;;;;;OAKG;IACH,WAAW,CACT,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,aAAa,GACvB,OAAO,CAAC,aAAa,CAAC,CAAC;IAC1B;;;;;;;;OAQG;IACH,YAAY,CACV,UAAU,EAAE,oBAAoB,EAChC,OAAO,CAAC,EAAE,MAAM,EAChB,SAAS,CAAC,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,kBAAkB,EAC5B,cAAc,CAAC,EAAE,cAAc,CAAC,aAAa,CAAC,GAC7C,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAC5B;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACrD;;;;OAIG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAC7D;;;;OAIG;IACH,YAAY,CACV,cAAc,CAAC,EAAE,cAAc,CAAC,aAAa,CAAC,GAC7C,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;CAC7B,CAAC;yBAEc,OAAO,KAAK,KAAG,QAAQ;AAAvC,wBAsGE;AAEF,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACrC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACtD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;CAC5C;AACD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,EACxC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,oBAAoB,CAOvB;AAED;;;;GAIG;AACH,wBAAsB,WAAW,CAAC,EAChC,SAAS,EACT,KAAK,GACN,EAAE;IACD,SAAS,EAAE,aAAa,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAMzB;AAED;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,EAC9B,OAAO,EACP,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAMzB;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,EACpC,SAAS,EACT,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAezB;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAAC,EAC/B,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAM3B;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,EAChC,OAAO,EACP,OAAwB,EACxB,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,kBAAkB,CAAC;IAC5B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAuBhC;AACD;;;;;GAKG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,SAAS,EACT,OAAwB,EACxB,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAuBhC;AAED;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,EACjC,OAAwB,EACxB,cAAuB,EACvB,KAAK,GACN,EAAE;IACD,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,cAAc,CAAC,EAAE,cAAc,CAAC,oBAAoB,CAAC,CAAC;IACtD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAwDhC;AAED;;;;;GAKG;AACH,wBAAsB,WAAW,CAAC,EAChC,OAAO,EACP,SAAS,EACT,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,aAAa,CAAC;IACzB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAUzB;AAED;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CAAC,EACjC,OAAO,EACP,SAAS,EACT,UAAU,EACV,OAAwB,EACxB,cAAuB,EACvB,KAAK,GACN,EAAE;IACD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,oBAAoB,CAAC;IACjC,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,cAAc,CAAC,EAAE,cAAc,CAAC,aAAa,CAAC,CAAC;IAC/C,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAiF3B;AAED;;;;GAIG;AACH,wBAAsB,WAAW,CAAC,EAChC,OAAO,EACP,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAMzB;AAED;;;;GAIG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,SAAS,EACT,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAazB;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,EACjC,cAAuB,EACvB,KAAK,GACN,EAAE;IACD,cAAc,CAAC,EAAE,cAAc,CAAC,aAAa,CAAC,CAAC;IAC/C,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAe3B"}