@rockcarver/frodo-lib 4.10.0 → 4.11.0-1

package/types/api/cloud/IdmFeatureApi.d.ts

@@ -0,0 +1,65 @@
+import { IdObjectSkeletonInterface } from '../../api/ApiTypes';
+import { State } from '../../shared/State';
+/**
+ * A single IDM tenant-configuration feature (e.g. `groups`, `aiagent`,
+ * `am/2fa/profiles`), distinct from `cloud.feature`'s environment-level
+ * entitlement/licensing flags (e.g. `identity-cloud`, `workforce`,
+ * `service-accounts`) -- confirmed live to be two entirely separate REST
+ * resources sharing similar terminology, not the same one. See
+ * `IdmFeatureOps.ts`'s header comment for the full distinction.
+ */
+export interface IdmFeatureInterface extends IdObjectSkeletonInterface {
+    installedVersion: string | null;
+    availableVersions: string[];
+}
+export interface IdmFeatureActionResult {
+    status: number;
+    success: boolean;
+    message: string;
+}
+/**
+ * Get all IDM tenant-configuration features and their install status.
+ * @returns {Promise<{ result: IdmFeatureInterface[] }>} a promise that resolves to an object containing an array of feature objects
+ */
+export declare function getIdmFeatures({ state, }: {
+    state: State;
+}): Promise<{
+    result: IdmFeatureInterface[];
+}>;
+/**
+ * Get a single IDM tenant-configuration feature and its install status.
+ * @param {string} featureId feature id, e.g. 'aiagent' or 'am/2fa/profiles'.
+ * Ids containing a literal slash work fine here -- confirmed live -- as long
+ * as it's sent as a real, unencoded path segment (this function's plain
+ * string interpolation already does that correctly); percent-encoding the
+ * slash (`%2F` or `%252F`) is what breaks it, so don't "fix" this by adding
+ * `encodeURIComponent`.
+ * @returns {Promise<IdmFeatureInterface>} a promise that resolves to the feature object
+ */
+export declare function getIdmFeature({ featureId, state, }: {
+    featureId: string;
+    state: State;
+}): Promise<IdmFeatureInterface>;
+/**
+ * Validate whether an IDM tenant-configuration feature is installable,
+ * without installing it.
+ * @param {string} featureId feature id, e.g. 'aiagent'
+ * @returns {Promise<IdmFeatureActionResult>} a promise that resolves to the validation result
+ */
+export declare function validateIdmFeature({ featureId, state, }: {
+    featureId: string;
+    state: State;
+}): Promise<IdmFeatureActionResult>;
+/**
+ * Install an IDM tenant-configuration feature. Irreversible: per Ping's own
+ * documentation, uninstalling or disabling a feature once installed requires
+ * contacting Ping support and rolling back the tenant -- there is no
+ * self-service undo.
+ * @param {string} featureId feature id, e.g. 'aiagent'
+ * @returns {Promise<IdmFeatureActionResult>} a promise that resolves to the install result
+ */
+export declare function installIdmFeature({ featureId, state, }: {
+    featureId: string;
+    state: State;
+}): Promise<IdmFeatureActionResult>;
+//# sourceMappingURL=IdmFeatureApi.d.ts.map

package/types/api/cloud/IdmFeatureApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IdmFeatureApi.d.ts","sourceRoot":"","sources":["../../../src/api/cloud/IdmFeatureApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAE/D,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAQ3C;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAoB,SAAQ,yBAAyB;IACpE,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,wBAAsB,cAAc,CAAC,EACnC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC;IAAE,MAAM,EAAE,mBAAmB,EAAE,CAAA;CAAE,CAAC,CAW7C;AAED;;;;;;;;;GASG;AACH,wBAAsB,aAAa,CAAC,EAClC,SAAS,EACT,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAY/B;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,SAAS,EACT,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAalC;AAED;;;;;;;GAOG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,SAAS,EACT,KAAK,GACN,EAAE;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAalC"}

package/types/api/cloud/LogApi.d.ts

@@ -0,0 +1,108 @@
+import { State } from '../../shared/State';
+import { type NoIdObjectSkeletonInterface, type PagedResult } from '../ApiTypes';
+export type LogApiKey = {
+    name: string;
+    api_key_id: string;
+    api_key_secret?: string;
+    created_at: string;
+};
+export type LogEventPayloadSkeleton = NoIdObjectSkeletonInterface & {
+    context: string;
+    level: string;
+    logger: string;
+    mdc: {
+        transactionId: string;
+    };
+    message: string;
+    thread: string;
+    timestamp: string;
+    transactionId: string;
+};
+export type LogEventSkeleton = NoIdObjectSkeletonInterface & {
+    payload: string | LogEventPayloadSkeleton;
+    timestamp: string;
+    type: string;
+    source: string;
+};
+/**
+ * Get log API key
+ * @returns {Promise<PagedResult<LogApiKey>>} a promise resolving to a log api key object
+ */
+export declare function getLogApiKey({ keyId, state, }: {
+    keyId: string;
+    state: State;
+}): Promise<LogApiKey>;
+/**
+ * Get available API keys
+ * @returns {Promise<PagedResult<LogApiKey>>} a promise resolving to a paged log api key results object
+ */
+export declare function getLogApiKeys({ state, }: {
+    state: State;
+}): Promise<PagedResult<LogApiKey>>;
+/**
+ * Get available log sources
+ * @returns {Promise<PagedResult<string>>} a promise resolving to a paged string results object
+ */
+export declare function getSources({ state, }: {
+    state: State;
+}): Promise<PagedResult<string>>;
+/**
+ * Validate log API key
+ * @param {string} keyId log api key id
+ * @param {string} secret log api secret
+ * @returns {Promise<boolean>} a promise resolving to true if the key is valid, false otherwise
+ */
+export declare function isLogApiKeyValid({ keyId, secret, state, }: {
+    keyId: string;
+    secret: string;
+    state: State;
+}): Promise<boolean>;
+/**
+ * Create API key
+ * @param {keyName: string, state: State} params keyName, state
+ * @returns {Promise<LogApiKey>} new API key and secret
+ */
+export declare function createLogApiKey({ keyName, state, }: {
+    keyName: string;
+    state: State;
+}): Promise<LogApiKey>;
+/**
+ * Delete log API key
+ * @param {string} keyId key id
+ * @returns {Promise<unknown>} a promise that resolves to a log api key object
+ */
+export declare function deleteLogApiKey({ keyId, state, }: {
+    keyId: string;
+    state: State;
+}): Promise<unknown>;
+/**
+ * Tail logs
+ * @param {string} source log source(s) to tail
+ * @param {string} cookie paged results cookie
+ * @returns {Promise<PagedResult<LogEventSkeleton>>} promise resolving to paged log event result
+ */
+export declare function tail({ source, cookie, state, }: {
+    source: string;
+    cookie: string;
+    state: State;
+}): Promise<PagedResult<LogEventSkeleton>>;
+/**
+ * Fetch logs
+ * @param {string} source log source(s) to tail
+ * @param {string} startTs start timestamp
+ * @param {string} endTs end timestamp
+ * @param {string} cookie paged results cookie
+ * @param {string} transactionId transaction id
+ * @param {string} queryFilter query filter
+ * @returns {Promise<PagedResult<LogEventSkeleton>>} promise resolving to paged log event result
+ */
+export declare function fetch({ source, startTs, endTs, cookie, txid, filter, state, }: {
+    source: string;
+    startTs: string;
+    endTs: string;
+    cookie: string;
+    txid: string;
+    filter: string;
+    state: State;
+}): Promise<PagedResult<LogEventSkeleton>>;
+//# sourceMappingURL=LogApi.d.ts.map

package/types/api/cloud/LogApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogApi.d.ts","sourceRoot":"","sources":["../../../src/api/cloud/LogApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAE3C,OAAO,EACL,KAAK,2BAA2B,EAChC,KAAK,WAAW,EACjB,MAAM,aAAa,CAAC;AAUrB,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,2BAA2B,GAAG;IAClE,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE;QACH,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,2BAA2B,GAAG;IAC3D,OAAO,EAAE,MAAM,GAAG,uBAAuB,CAAC;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;GAGG;AACH,wBAAsB,YAAY,CAAC,EACjC,KAAK,EACL,KAAK,GACN,EAAE;IACD,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,SAAS,CAAC,CAQrB;AAED;;;GAGG;AACH,wBAAsB,aAAa,CAAC,EAClC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAOlC;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAAC,EAC/B,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAO/B;AAED;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,KAAK,EACL,MAAM,EACN,KAAK,GACN,EAAE;IACD,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAkBnB;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,EACpC,OAAO,EACP,KAAK,GACN,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,SAAS,CAAC,CASrB;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,EACpC,KAAK,EACL,KAAK,GACN,EAAE;IACD,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,OAAO,CAAC,CAUnB;AAED;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,EACzB,MAAM,EACN,MAAM,EACN,KAAK,GACN,EAAE;IACD,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAWzC;AAED;;;;;;;;;GASG;AACH,wBAAsB,KAAK,CAAC,EAC1B,MAAM,EACN,OAAO,EACP,KAAK,EACL,MAAM,EACN,IAAI,EACJ,MAAM,EACN,KAAK,GACN,EAAE;IACD,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAwBzC"}

package/types/api/cloud/SecretsApi.d.ts

@@ -0,0 +1,163 @@
+import { State } from '../../shared/State';
+import { IdObjectSkeletonInterface, PagedResult } from '../ApiTypes';
+/**
+ * Secret encoding
+ *
+ * @summary
+ * You can use the encoding parameter to set an encoding format when you create an ESV secret.
+ * You can only choose an encoding format using the API. The UI currently creates secrets only
+ * with the generic encoding format.
+ *
+ * @see
+ * {@link https://backstage.forgerock.com/docs/idcloud/latest/tenants/esvs.html#encoding_format | ForgeRock Documentation}
+ */
+export type SecretEncodingType = 'generic' | 'pem' | 'base64hmac' | 'base64aes';
+/**
+ * Secret object skeleton
+ */
+export type SecretSkeleton = IdObjectSkeletonInterface & {
+    description: string;
+    encoding: SecretEncodingType;
+    lastChangedBy?: string;
+    lastChangeDate?: string;
+    useInPlaceholders: boolean;
+    loaded?: boolean;
+    loadedVersion?: string;
+    activeVersion?: string;
+    activeValue?: any;
+};
+export type VersionOfSecretStatus = 'DISABLED' | 'ENABLED' | 'DESTROYED';
+/**
+ * Secret version skeleton
+ */
+export type VersionOfSecretSkeleton = IdObjectSkeletonInterface & {
+    /**
+     * Base64-encoded value. Only used when creating a new version of a secret
+     */
+    valueBase64?: string;
+    /**
+     * Version string. Returned when reading a version of a secret
+     */
+    version?: string;
+    /**
+     * Date string. Returned when reading a version of a secret
+     */
+    createDate?: string;
+    /**
+     * True if loaded, false otherwise. Returned when reading a version of a secret
+     */
+    loaded?: boolean;
+    /**
+     * Status string. Returned when reading a version of a secret
+     */
+    status?: VersionOfSecretStatus;
+};
+/**
+ * Get all secrets
+ * @returns {Promise<PagedResult<SecretSkeleton>>} a promise that resolves to an array of secrets
+ */
+export declare function getSecrets({ state, }: {
+    state: State;
+}): Promise<PagedResult<SecretSkeleton>>;
+/**
+ * Get secret
+ * @param secretId secret id/name
+ * @returns {Promise<SecretSkeleton>} a promise that resolves to a secret
+ */
+export declare function getSecret({ secretId, state, }: {
+    secretId: string;
+    state: State;
+}): Promise<SecretSkeleton>;
+/**
+ * Create secret
+ * @param {string} secretId secret id/name
+ * @param {string} value secret value
+ * @param {string} description secret description
+ * @param {string} encoding secret encoding (only `generic` is supported)
+ * @param {boolean} useInPlaceholders flag indicating if the secret can be used in placeholders
+ * @returns {Promise<SecretSkeleton>} a promise that resolves to a secret
+ */
+export declare function putSecret({ secretId, value, description, encoding, useInPlaceholders, state, }: {
+    secretId: string;
+    value: string;
+    description: string;
+    encoding?: string;
+    useInPlaceholders?: boolean;
+    state: State;
+}): Promise<SecretSkeleton>;
+/**
+ * Set secret description
+ * @param {string} secretId secret id/name
+ * @param {string} description secret description
+ * @returns {Promise<any>} a promise that resolves to an empty string
+ */
+export declare function setSecretDescription({ secretId, description, state, }: {
+    secretId: string;
+    description: string;
+    state: State;
+}): Promise<any>;
+/**
+ * Delete secret
+ * @param {string} secretId secret id/name
+ * @returns {Promise<unknown>} a promise that resolves to a secret object
+ */
+export declare function deleteSecret({ secretId, state, }: {
+    secretId: string;
+    state: State;
+}): Promise<any>;
+/**
+ * Get secret versions
+ * @param {string} secretId secret id/name
+ * @returns {Promise<VersionOfSecretSkeleton[]>} a promise that resolves to an array of secret versions
+ */
+export declare function getSecretVersions({ secretId, state, }: {
+    secretId: string;
+    state: State;
+}): Promise<VersionOfSecretSkeleton[]>;
+/**
+ * Create new secret version
+ * @param {string} secretId secret id/name
+ * @param {string} value secret value
+ * @returns {Promise<VersionOfSecretSkeleton>} a promise that resolves to a version object
+ */
+export declare function createNewVersionOfSecret({ secretId, value, state, }: {
+    secretId: string;
+    value: string;
+    state: State;
+}): Promise<VersionOfSecretSkeleton>;
+/**
+ * Get version of secret
+ * @param {string} secretId secret id/name
+ * @param {string} version secret version
+ * @returns {Promise<VersionOfSecretSkeleton>} a promise that resolves to a version object
+ */
+export declare function getVersionOfSecret({ secretId, version, state, }: {
+    secretId: string;
+    version: string;
+    state: State;
+}): Promise<VersionOfSecretSkeleton>;
+/**
+ * Update the status of a version of a secret
+ * @param {string} secretId secret id/name
+ * @param {string} version secret version
+ * @param {VersionOfSecretStatus} status status
+ * @returns {Promise<VersionOfSecretSkeleton>} a promise that resolves to a status object
+ */
+export declare function setStatusOfVersionOfSecret({ secretId, version, status, state, }: {
+    secretId: string;
+    version: string;
+    status: VersionOfSecretStatus;
+    state: State;
+}): Promise<VersionOfSecretSkeleton>;
+/**
+ * Delete version of secret
+ * @param {string} secretId secret id/name
+ * @param {string} version secret version
+ * @returns {Promise<VersionOfSecretSkeleton>} a promise that resolves to a version object
+ */
+export declare function deleteVersionOfSecret({ secretId, version, state, }: {
+    secretId: string;
+    version: string;
+    state: State;
+}): Promise<VersionOfSecretSkeleton>;
+//# sourceMappingURL=SecretsApi.d.ts.map

package/types/api/cloud/SecretsApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SecretsApi.d.ts","sourceRoot":"","sources":["../../../src/api/cloud/SecretsApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAE3C,OAAO,EAAE,yBAAyB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAiBrE;;;;;;;;;;GAUG;AACH,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,KAAK,GAAG,YAAY,GAAG,WAAW,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,yBAAyB,GAAG;IACvD,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,GAAG,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,yBAAyB,GAAG;IAChE;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAC;CAChC,CAAC;AAEF;;;GAGG;AACH,wBAAsB,UAAU,CAAC,EAC/B,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAavC;AAED;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,EAC9B,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,CAAC,CAc1B;AAED;;;;;;;;GAQG;AACH,wBAAsB,SAAS,CAAC,EAC9B,QAAQ,EACR,KAAK,EACL,WAAW,EACX,QAAoB,EACpB,iBAAwB,EACxB,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,cAAc,CAAC,CAoB1B;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,QAAQ,EACR,WAAW,EACX,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,GAAG,CAAC,CAYf;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,EACjC,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,gBAcA;AAED;;;;GAIG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,QAAQ,EACR,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAcrC;AAED;;;;;GAKG;AACH,wBAAsB,wBAAwB,CAAC,EAC7C,QAAQ,EACR,KAAK,EACL,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAYnC;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,QAAQ,EACR,OAAO,EACP,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAenC;AAED;;;;;;GAMG;AACH,wBAAsB,0BAA0B,CAAC,EAC/C,QAAQ,EACR,OAAO,EACP,MAAM,EACN,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,qBAAqB,CAAC;IAC9B,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAanC;AAED;;;;;GAKG;AACH,wBAAsB,qBAAqB,CAAC,EAC1C,QAAQ,EACR,OAAO,EACP,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAenC"}

package/types/api/cloud/StartupApi.d.ts

@@ -0,0 +1,20 @@
+import { State } from '../../shared/State';
+export declare enum RestartStatus {
+    restarting = "restarting",
+    ready = "ready"
+}
+/**
+ * Get status
+ * @returns {Promise<RestartStatus>} a promise that resolves to a string indicating status
+ */
+export declare function getStatus({ state, }: {
+    state: State;
+}): Promise<RestartStatus>;
+/**
+ * Initiate restart
+ * @returns {Promise<string>} a promise that resolves to a string indicating status
+ */
+export declare function initiateRestart({ state, }: {
+    state: State;
+}): Promise<RestartStatus>;
+//# sourceMappingURL=StartupApi.d.ts.map

package/types/api/cloud/StartupApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StartupApi.d.ts","sourceRoot":"","sources":["../../../src/api/cloud/StartupApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAa3C,oBAAY,aAAa;IACvB,UAAU,eAAe;IACzB,KAAK,UAAU;CAChB;AAED;;;GAGG;AACH,wBAAsB,SAAS,CAAC,EAC9B,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAczB;AAED;;;GAGG;AACH,wBAAsB,eAAe,CAAC,EACpC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,aAAa,CAAC,CAkBzB"}

package/types/api/cloud/TelemetryApi.d.ts

@@ -0,0 +1,60 @@
+import { State } from '../../shared/State';
+export type LogSource = 'am-access' | 'am-activity' | 'am-authentication' | 'am-config' | 'am-core' | 'am-everything' | 'environment-access' | 'idm-access' | 'idm-activity' | 'idm-authentication' | 'idm-config' | 'idm-core' | 'idm-recon' | 'idm-sync' | 'idm-everything' | 'ws-activity' | 'ws-config' | 'ws-core' | 'ws-everything';
+export type OtlpExporterType = 'HTTP' | 'GRPC';
+export type OtlpExporterEncoding = 'JSON' | 'PROTO';
+export type OtlpBasicAuth = {
+    username: string;
+    password: string;
+};
+export type LogExporterSkeleton = {
+    id: string;
+    endpoint: string;
+    sources: string[];
+};
+export type TelemetryExporterCategory = 'otlp' | 'splunk';
+export type OtlpExporterSkeleton = LogExporterSkeleton & {
+    type: OtlpExporterType;
+    encoding?: OtlpExporterEncoding;
+    headers?: Record<string, string>;
+    basicAuth?: OtlpBasicAuth;
+};
+export type SplunkExporterSkeleton = LogExporterSkeleton & {
+    index?: string;
+    token: string;
+};
+export type TelemetryExporters = {
+    otlp: OtlpExporterSkeleton[];
+    splunk: SplunkExporterSkeleton[];
+};
+/**
+ * Get telemetry exporters
+ * @returns {Promise<TelemetryExporters>} promise resolving to telemetry exporters
+ */
+export declare function getTelemetryExporters({ state, }: {
+    state: State;
+}): Promise<TelemetryExporters>;
+/**
+ * Create or update an OTLP or Splunk log exporter
+ * @param {TelemetryExporterCategory} category exporter category ('otlp' or 'splunk')
+ * @param {string} exporterId exporter id
+ * @param {LogExporterSkeleton} exporterData exporter config, matching type indicated by category
+ * @returns {Promise<LogExporterSkeleton>} promise resolving to the created/updated exporter
+ */
+export declare function putTelemetryExporter({ category, exporterId, exporterData, state, }: {
+    category: TelemetryExporterCategory;
+    exporterId: string;
+    exporterData: LogExporterSkeleton;
+    state: State;
+}): Promise<LogExporterSkeleton>;
+/**
+ * Delete a telemetry exporter
+ * @param {TelemetryExporterCategory} category exporter category ('otlp' or 'splunk')
+ * @param {string} exporterId exporter id
+ * @returns {Promise<LogExporterSkeleton>} promise resolving when the exporter has been deleted
+ */
+export declare function deleteTelemetryExporter({ category, exporterId, state, }: {
+    category: TelemetryExporterCategory;
+    exporterId: string;
+    state: State;
+}): Promise<LogExporterSkeleton>;
+//# sourceMappingURL=TelemetryApi.d.ts.map

package/types/api/cloud/TelemetryApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TelemetryApi.d.ts","sourceRoot":"","sources":["../../../src/api/cloud/TelemetryApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAY3C,MAAM,MAAM,SAAS,GACjB,WAAW,GACX,aAAa,GACb,mBAAmB,GACnB,WAAW,GACX,SAAS,GACT,eAAe,GACf,oBAAoB,GACpB,YAAY,GACZ,cAAc,GACd,oBAAoB,GACpB,YAAY,GACZ,UAAU,GACV,WAAW,GACX,UAAU,GACV,gBAAgB,GAChB,aAAa,GACb,WAAW,GACX,SAAS,GACT,eAAe,CAAC;AAEpB,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,CAAC;AAE/C,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,OAAO,CAAC;AAEpD,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE1D,MAAM,MAAM,oBAAoB,GAAG,mBAAmB,GAAG;IACvD,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,SAAS,CAAC,EAAE,aAAa,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,GAAG;IACzD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AACF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,oBAAoB,EAAE,CAAC;IAC7B,MAAM,EAAE,sBAAsB,EAAE,CAAC;CAClC,CAAC;AACF;;;GAGG;AACH,wBAAsB,qBAAqB,CAAC,EAC1C,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAa9B;AACD;;;;;;GAMG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,QAAQ,EACR,UAAU,EACV,YAAY,EACZ,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,yBAAyB,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,mBAAmB,CAAC;IAClC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAiB/B;AACD;;;;;GAKG;AACH,wBAAsB,uBAAuB,CAAC,EAC5C,QAAQ,EACR,UAAU,EACV,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,yBAAyB,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAmB/B"}

package/types/api/cloud/VariablesApi.d.ts

@@ -0,0 +1,86 @@
+import { State } from '../../shared/State';
+import { IdObjectSkeletonInterface, PagedResult } from '../ApiTypes';
+/**
+ * Variable types
+ *
+ * @summary
+ * You can use the expressionType parameter to set a type when you create an ESV variable.
+ * This lets Identity Cloud correctly transform the value of the ESV
+ * to match the configuration property type when substituting it into configuration.
+ *
+ * The type is set when the ESV is created, and cannot be modified after creation.
+ * If you do not specify a type, it will default to string.
+ *
+ * Before the expressionType parameter was introduced, it was only possible to set types
+ * from within configuration, using expression level syntax; for example,
+ * {"$int": "&{esv.journey.ldap.port|1389}"}.
+ * The expressionType parameter supplements this expression level syntax and allows the
+ * ESV type to be identified without inspecting configuration.
+ *
+ * @see
+ * {@link https://backstage.forgerock.com/docs/idcloud/latest/tenants/esvs.html#variable_types | ForgeRock Documentation}
+ */
+export type VariableExpressionType = 'array' | 'base64encodedinlined' | 'bool' | 'int' | 'keyvaluelist' | 'list' | 'number' | 'object' | 'string';
+/**
+ * Variable object skeleton
+ */
+export type VariableSkeleton = IdObjectSkeletonInterface & {
+    valueBase64?: string;
+    value?: string;
+    description?: string;
+    loaded?: boolean;
+    lastChangedBy?: string;
+    lastChangeDate?: string;
+    expressionType?: VariableExpressionType;
+};
+/**
+ * Get all variables
+ * @returns {Promise<PagedResult<VariableSkeleton>>} a promise that resolves to an array of variable objects
+ */
+export declare function getVariables({ state, }: {
+    state: State;
+}): Promise<PagedResult<VariableSkeleton>>;
+/**
+ * Get variable by id/name
+ * @param {string} variableId variable id/name
+ * @returns {Promise<VariableSkeleton>} a promise that resolves to a variable object
+ */
+export declare function getVariable({ variableId, state, }: {
+    variableId: string;
+    state: State;
+}): Promise<VariableSkeleton>;
+/**
+ * Create or update variable by id/name
+ * @param {string} variableId variable id/name
+ * @param {string} valueBase64 base64-encoded variable value
+ * @param {string} description variable description
+ * @returns {Promise<unknown>} a promise that resolves to a variable object
+ */
+export declare function putVariable({ variableId, valueBase64, description, expressionType, state, }: {
+    variableId: string;
+    valueBase64: string;
+    description?: string;
+    expressionType?: VariableExpressionType;
+    state: State;
+}): Promise<VariableSkeleton>;
+/**
+ * Set variable description
+ * @param {string} variableId variable id/name
+ * @param {string} description variable description
+ * @returns {Promise<any>} a promise that resolves to an empty string.
+ */
+export declare function setVariableDescription({ variableId, description, state, }: {
+    variableId: string;
+    description: string;
+    state: State;
+}): Promise<any>;
+/**
+ * Delete variable by id/name
+ * @param {string} variableId variable id/name
+ * @returns {Promise<VariableSkeleton>} a promise that resolves to a variable object
+ */
+export declare function deleteVariable({ variableId, state, }: {
+    variableId: string;
+    state: State;
+}): Promise<VariableSkeleton>;
+//# sourceMappingURL=VariablesApi.d.ts.map

package/types/api/cloud/VariablesApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VariablesApi.d.ts","sourceRoot":"","sources":["../../../src/api/cloud/VariablesApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAE3C,OAAO,EAAE,yBAAyB,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAcrE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,sBAAsB,GAC9B,OAAO,GACP,sBAAsB,GACtB,MAAM,GACN,KAAK,GACL,cAAc,GACd,MAAM,GACN,QAAQ,GACR,QAAQ,GACR,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,yBAAyB,GAAG;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,sBAAsB,CAAC;CACzC,CAAC;AAEF;;;GAGG;AACH,wBAAsB,YAAY,CAAC,EACjC,KAAK,GACN,EAAE;IACD,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC,CAazC;AAED;;;;GAIG;AACH,wBAAsB,WAAW,CAAC,EAChC,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAc5B;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,EAChC,UAAU,EACV,WAAW,EACX,WAAW,EACX,cAAyB,EACzB,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,sBAAsB,CAAC;IACxC,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAmB5B;AAED;;;;;GAKG;AACH,wBAAsB,sBAAsB,CAAC,EAC3C,UAAU,EACV,WAAW,EACX,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,GAAG,CAAC,CAYf;AAED;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,EACnC,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAc5B"}