@thunderid/javascript 1.5.0 → 1.7.0

package/dist/api/management/agents/regenerateAgentSecret.d.ts

@@ -0,0 +1,25 @@
+import { Agent } from '../../../models/agent-resource';
+import { ManagementRequestConfig } from '../../../models/api';
+export interface RegenerateAgentSecretConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the agent.
+     */
+    agentId: string;
+}
+export interface RegenerateAgentSecretResult {
+    /**
+     * The agent after the change.
+     */
+    agent: Agent;
+    /**
+     * The new client secret. This is the only time it can be read.
+     */
+    clientSecret: string;
+}
+/**
+ * Gives an agent's OAuth client a new secret, generated here and saved on the agent. Fails when the
+ * agent has no OAuth client.
+ */
+declare const regenerateAgentSecret: ({ agentId, ...config }: RegenerateAgentSecretConfig) => Promise<RegenerateAgentSecretResult>;
+export default regenerateAgentSecret;
+//# sourceMappingURL=regenerateAgentSecret.d.ts.map

package/dist/api/management/agents/regenerateAgentSecret.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"regenerateAgentSecret.d.ts","sourceRoot":"","sources":["../../../../src/api/management/agents/regenerateAgentSecret.ts"],"names":[],"mappings":"AAMA,OAAO,EAAC,KAAK,EAAyB,MAAM,gCAAgC,CAAC;AAC7E,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAI5D,MAAM,WAAW,2BAA4B,SAAQ,uBAAuB;IAC1E;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IACb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,QAAA,MAAM,qBAAqB,GAAU,wBAGlC,2BAA2B,KAAG,OAAO,CAAC,2BAA2B,CAmCnE,CAAC;AAEF,eAAe,qBAAqB,CAAC"}

package/dist/api/management/agents/suspendAgent.d.ts

@@ -0,0 +1,29 @@
+import { AccountLifecycleOptions, AccountLifecycleResult } from '../../../models/administration';
+import { ManagementRequestConfig } from '../../../models/api';
+/**
+ * Configuration for the suspendAgent request.
+ */
+export interface SuspendAgentConfig extends ManagementRequestConfig, AccountLifecycleOptions {
+    /**
+     * Identifier of the agent.
+     */
+    agentId: string;
+}
+/**
+ * Suspends an agent, so it can no longer authenticate, through the agent suspension flow the server
+ * configures. There is no management API endpoint for this, so when no flow is configured the call fails
+ * with `suspendAgent-NotConfiguredError-001`.
+ *
+ * @param config - Request configuration object. Running a flow needs `baseUrl`, and a token that may read
+ * the server configuration and run administration flows.
+ * @returns A promise that resolves with whether the flow's email step sent its notification, absent when
+ * the flow has no email step.
+ *
+ * @example
+ * ```typescript
+ * const {emailSent} = await suspendAgent({baseUrl: 'https://localhost:8090', agentId, operatorNote: 'Ticket 4521'});
+ * ```
+ */
+declare const suspendAgent: ({ agentId, operatorNote, ...config }: SuspendAgentConfig) => Promise<AccountLifecycleResult>;
+export default suspendAgent;
+//# sourceMappingURL=suspendAgent.d.ts.map

package/dist/api/management/agents/suspendAgent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suspendAgent.d.ts","sourceRoot":"","sources":["../../../../src/api/management/agents/suspendAgent.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,uBAAuB,EAAE,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AAC/F,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAG5D;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB,EAAE,uBAAuB;IAC1F;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,YAAY,GAAU,sCAAoC,kBAAkB,KAAG,OAAO,CAAC,sBAAsB,CAO/G,CAAC;AAEL,eAAe,YAAY,CAAC"}

package/dist/api/management/agents/unlockAgent.d.ts

@@ -0,0 +1,29 @@
+import { AccountLifecycleOptions, AccountLifecycleResult } from '../../../models/administration';
+import { ManagementRequestConfig } from '../../../models/api';
+/**
+ * Configuration for the unlockAgent request.
+ */
+export interface UnlockAgentConfig extends ManagementRequestConfig, AccountLifecycleOptions {
+    /**
+     * Identifier of the agent.
+     */
+    agentId: string;
+}
+/**
+ * Unlocks an agent locked out after repeated failed authentication attempts, through the agent unlock flow
+ * the server configures. There is no management API endpoint for this, so when no flow is configured the
+ * call fails with `unlockAgent-NotConfiguredError-001`.
+ *
+ * @param config - Request configuration object. Running a flow needs `baseUrl`, and a token that may read
+ * the server configuration and run administration flows.
+ * @returns A promise that resolves with whether the flow's email step sent its notification, absent when
+ * the flow has no email step.
+ *
+ * @example
+ * ```typescript
+ * const {emailSent} = await unlockAgent({baseUrl: 'https://localhost:8090', agentId, operatorNote: 'Ticket 4521'});
+ * ```
+ */
+declare const unlockAgent: ({ agentId, operatorNote, ...config }: UnlockAgentConfig) => Promise<AccountLifecycleResult>;
+export default unlockAgent;
+//# sourceMappingURL=unlockAgent.d.ts.map

package/dist/api/management/agents/unlockAgent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unlockAgent.d.ts","sourceRoot":"","sources":["../../../../src/api/management/agents/unlockAgent.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,uBAAuB,EAAE,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AAC/F,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAG5D;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB,EAAE,uBAAuB;IACzF;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,WAAW,GAAU,sCAAoC,iBAAiB,KAAG,OAAO,CAAC,sBAAsB,CAO7G,CAAC;AAEL,eAAe,WAAW,CAAC"}

package/dist/api/management/agents/unsuspendAgent.d.ts

@@ -0,0 +1,29 @@
+import { AccountLifecycleOptions, AccountLifecycleResult } from '../../../models/administration';
+import { ManagementRequestConfig } from '../../../models/api';
+/**
+ * Configuration for the unsuspendAgent request.
+ */
+export interface UnsuspendAgentConfig extends ManagementRequestConfig, AccountLifecycleOptions {
+    /**
+     * Identifier of the agent.
+     */
+    agentId: string;
+}
+/**
+ * Lifts the suspension of an agent through the agent unsuspension flow the server configures. There is no
+ * management API endpoint for this, so when no flow is configured the call fails with
+ * `unsuspendAgent-NotConfiguredError-001`.
+ *
+ * @param config - Request configuration object. Running a flow needs `baseUrl`, and a token that may read
+ * the server configuration and run administration flows.
+ * @returns A promise that resolves with whether the flow's email step sent its notification, absent when
+ * the flow has no email step.
+ *
+ * @example
+ * ```typescript
+ * const {emailSent} = await unsuspendAgent({baseUrl: 'https://localhost:8090', agentId, operatorNote: 'Ticket 4521'});
+ * ```
+ */
+declare const unsuspendAgent: ({ agentId, operatorNote, ...config }: UnsuspendAgentConfig) => Promise<AccountLifecycleResult>;
+export default unsuspendAgent;
+//# sourceMappingURL=unsuspendAgent.d.ts.map

package/dist/api/management/agents/unsuspendAgent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unsuspendAgent.d.ts","sourceRoot":"","sources":["../../../../src/api/management/agents/unsuspendAgent.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,uBAAuB,EAAE,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AAC/F,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAG5D;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB,EAAE,uBAAuB;IAC5F;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,cAAc,GAAU,sCAI3B,oBAAoB,KAAG,OAAO,CAAC,sBAAsB,CAOpD,CAAC;AAEL,eAAe,cAAc,CAAC"}

package/dist/api/{agents → management/agents}/updateAgent.d.ts

@@ -1,5 +1,5 @@
-import { Agent, UpdateAgentRequest } from '../../models/agent-resource';
-import { ManagementRequestConfig } from '../../models/api';
+import { Agent, UpdateAgentRequest } from '../../../models/agent-resource';
+import { ManagementRequestConfig } from '../../../models/api';
 /**
  * Configuration for the updateAgent request.
  */

package/dist/api/management/agents/updateAgent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateAgent.d.ts","sourceRoot":"","sources":["../../../../src/api/management/agents/updateAgent.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,KAAK,EAAE,kBAAkB,EAAC,MAAM,gCAAgC,CAAC;AACzE,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAG5D;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;IAChE;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,WAAW,GAAU,iCAA+B,iBAAiB,KAAG,OAAO,CAAC,KAAK,CAQvF,CAAC;AAEL,eAAe,WAAW,CAAC"}

package/dist/api/{applications → management/applications}/createApplication.d.ts

@@ -1,5 +1,5 @@
-import { ManagementRequestConfig } from '../../models/api';
-import { Application, CreateApplicationRequest } from '../../models/application';
+import { ManagementRequestConfig } from '../../../models/api';
+import { Application, CreateApplicationRequest } from '../../../models/application';
 /**
  * Configuration for the createApplication request.
  */

package/dist/api/management/applications/createApplication.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createApplication.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/createApplication.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,WAAW,EAAE,wBAAwB,EAAC,MAAM,6BAA6B,CAAC;AAGlF;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;IACtE;;OAEG;IACH,OAAO,EAAE,wBAAwB,CAAC;CACnC;AAED;;;;;;;;;;;;;GAaG;AACH,QAAA,MAAM,iBAAiB,GAAU,wBAAsB,uBAAuB,KAAG,OAAO,CAAC,WAAW,CAOhG,CAAC;AAEL,eAAe,iBAAiB,CAAC"}

package/dist/api/management/applications/createApplicationSharingPolicy.d.ts

@@ -0,0 +1,33 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { SharingPolicy, SharingPolicyRequest } from '../../../models/sharing-policy';
+/**
+ * Configuration for the createApplicationSharingPolicy request.
+ */
+export interface CreateApplicationSharingPolicyConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the application.
+     */
+    applicationId: string;
+    /**
+     * The policy to create.
+     */
+    payload: SharingPolicyRequest;
+}
+/**
+ * Creates a sharing policy for an application: the organization units it reaches beyond its owner.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the policy as the server stored it.
+ *
+ * @example
+ * ```typescript
+ * const policy = await createApplicationSharingPolicy({
+ *   baseUrl: 'https://localhost:8090',
+ *   applicationId,
+ *   payload: {childUnits: {mode: 'all'}},
+ * });
+ * ```
+ */
+declare const createApplicationSharingPolicy: ({ applicationId, payload, ...config }: CreateApplicationSharingPolicyConfig) => Promise<SharingPolicy>;
+export default createApplicationSharingPolicy;
+//# sourceMappingURL=createApplicationSharingPolicy.d.ts.map

package/dist/api/management/applications/createApplicationSharingPolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createApplicationSharingPolicy.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/createApplicationSharingPolicy.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,aAAa,EAAE,oBAAoB,EAAC,MAAM,gCAAgC,CAAC;AAGnF;;GAEG;AACH,MAAM,WAAW,oCAAqC,SAAQ,uBAAuB;IACnF;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,EAAE,oBAAoB,CAAC;CAC/B;AAED;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,8BAA8B,GAAU,uCAI3C,oCAAoC,KAAG,OAAO,CAAC,aAAa,CAS3D,CAAC;AAEL,eAAe,8BAA8B,CAAC"}

package/dist/api/management/applications/deleteApplication.d.ts

@@ -0,0 +1,15 @@
+import { AdministrationOptions } from '../../../models/administration';
+import { ManagementRequestConfig } from '../../../models/api';
+export interface DeleteApplicationConfig extends ManagementRequestConfig, AdministrationOptions {
+    /**
+     * Identifier of the application to delete.
+     */
+    applicationId: string;
+}
+/**
+ * Deletes an application. In `flow` mode the configured application deletion flow runs instead,
+ * revoking what the application was granted before the record goes.
+ */
+declare const deleteApplication: ({ administrationMode, applicationId, ...config }: DeleteApplicationConfig) => Promise<void>;
+export default deleteApplication;
+//# sourceMappingURL=deleteApplication.d.ts.map

package/dist/api/management/applications/deleteApplication.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteApplication.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/deleteApplication.ts"],"names":[],"mappings":"AAOA,OAAO,EAAC,qBAAqB,EAAC,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAI5D,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB,EAAE,qBAAqB;IAC7F;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,QAAA,MAAM,iBAAiB,GAAU,kDAI9B,uBAAuB,KAAG,OAAO,CAAC,IAAI,CAqBxC,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/dist/api/management/applications/deleteApplicationSharingPolicy.d.ts

@@ -0,0 +1,28 @@
+import { ManagementRequestConfig } from '../../../models/api';
+/**
+ * Configuration for the deleteApplicationSharingPolicy request.
+ */
+export interface DeleteApplicationSharingPolicyConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the application.
+     */
+    applicationId: string;
+    /**
+     * Identifier of the sharing policy.
+     */
+    policyId: string;
+}
+/**
+ * Deletes a sharing policy of an application.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves once the server has made the change.
+ *
+ * @example
+ * ```typescript
+ * await deleteApplicationSharingPolicy({baseUrl: 'https://localhost:8090', applicationId, policyId});
+ * ```
+ */
+declare const deleteApplicationSharingPolicy: ({ applicationId, policyId, ...config }: DeleteApplicationSharingPolicyConfig) => Promise<void>;
+export default deleteApplicationSharingPolicy;
+//# sourceMappingURL=deleteApplicationSharingPolicy.d.ts.map

package/dist/api/management/applications/deleteApplicationSharingPolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteApplicationSharingPolicy.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/deleteApplicationSharingPolicy.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAI5D;;GAEG;AACH,MAAM,WAAW,oCAAqC,SAAQ,uBAAuB;IACnF;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,8BAA8B,GAAU,wCAI3C,oCAAoC,KAAG,OAAO,CAAC,IAAI,CASrD,CAAC;AAEF,eAAe,8BAA8B,CAAC"}

package/dist/api/{applications → management/applications}/getApplication.d.ts

@@ -1,5 +1,5 @@
-import { ManagementRequestConfig } from '../../models/api';
-import { Application } from '../../models/application';
+import { ManagementRequestConfig } from '../../../models/api';
+import { Application } from '../../../models/application';
 /**
  * Configuration for the getApplication request.
  */

package/dist/api/management/applications/getApplication.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getApplication.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/getApplication.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,WAAW,EAAC,MAAM,6BAA6B,CAAC;AAGxD;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB;IACnE;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;;GAaG;AACH,QAAA,MAAM,cAAc,GAAU,8BAA4B,oBAAoB,KAAG,OAAO,CAAC,WAAW,CAOhG,CAAC;AAEL,eAAe,cAAc,CAAC"}

package/dist/api/management/applications/getApplicationOverlayRules.d.ts

@@ -0,0 +1,29 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { ResolvedOverlay } from '../../../models/sharing-policy';
+/**
+ * Configuration for the getApplicationOverlayRules request.
+ */
+export interface GetApplicationOverlayRulesConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the application.
+     */
+    applicationId: string;
+    /**
+     * Identifier of the organization unit to resolve the rules for.
+     */
+    ouId: string;
+}
+/**
+ * Retrieves the overlay rules that apply to an application in an organization unit.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the resolved overlay.
+ *
+ * @example
+ * ```typescript
+ * const {rules} = await getApplicationOverlayRules({baseUrl: 'https://localhost:8090', applicationId, ouId});
+ * ```
+ */
+declare const getApplicationOverlayRules: ({ applicationId, ouId, ...config }: GetApplicationOverlayRulesConfig) => Promise<ResolvedOverlay>;
+export default getApplicationOverlayRules;
+//# sourceMappingURL=getApplicationOverlayRules.d.ts.map

package/dist/api/management/applications/getApplicationOverlayRules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getApplicationOverlayRules.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/getApplicationOverlayRules.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,eAAe,EAAC,MAAM,gCAAgC,CAAC;AAG/D;;GAEG;AACH,MAAM,WAAW,gCAAiC,SAAQ,uBAAuB;IAC/E;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,0BAA0B,GAAU,oCAIvC,gCAAgC,KAAG,OAAO,CAAC,eAAe,CASzD,CAAC;AAEL,eAAe,0BAA0B,CAAC"}

package/dist/api/management/applications/getApplicationSharingPolicies.d.ts

@@ -0,0 +1,25 @@
+import { ApiFilteringParams, ManagementRequestConfig } from '../../../models/api';
+import { SharingPolicyListResponse } from '../../../models/sharing-policy';
+/**
+ * Configuration for the getApplicationSharingPolicies request.
+ */
+export interface GetApplicationSharingPoliciesConfig extends ManagementRequestConfig, Pick<ApiFilteringParams, 'limit' | 'offset'> {
+    /**
+     * Identifier of the application.
+     */
+    applicationId: string;
+}
+/**
+ * Retrieves a page of the sharing policies of an application.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the page the server returned.
+ *
+ * @example
+ * ```typescript
+ * const {policies} = await getApplicationSharingPolicies({baseUrl: 'https://localhost:8090', applicationId});
+ * ```
+ */
+declare const getApplicationSharingPolicies: ({ applicationId, limit, offset, ...config }: GetApplicationSharingPoliciesConfig) => Promise<SharingPolicyListResponse>;
+export default getApplicationSharingPolicies;
+//# sourceMappingURL=getApplicationSharingPolicies.d.ts.map

package/dist/api/management/applications/getApplicationSharingPolicies.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getApplicationSharingPolicies.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/getApplicationSharingPolicies.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,kBAAkB,EAAE,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAC,yBAAyB,EAAC,MAAM,gCAAgC,CAAC;AAGzE;;GAEG;AACH,MAAM,WAAW,mCACf,SAAQ,uBAAuB,EAC7B,IAAI,CAAC,kBAAkB,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC9C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,6BAA6B,GAAU,6CAK1C,mCAAmC,KAAG,OAAO,CAAC,yBAAyB,CAStE,CAAC;AAEL,eAAe,6BAA6B,CAAC"}

package/dist/api/management/applications/getApplicationSharingPolicy.d.ts

@@ -0,0 +1,29 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { SharingPolicy } from '../../../models/sharing-policy';
+/**
+ * Configuration for the getApplicationSharingPolicy request.
+ */
+export interface GetApplicationSharingPolicyConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the application.
+     */
+    applicationId: string;
+    /**
+     * Identifier of the sharing policy.
+     */
+    policyId: string;
+}
+/**
+ * Retrieves a sharing policy of an application.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the policy.
+ *
+ * @example
+ * ```typescript
+ * const policy = await getApplicationSharingPolicy({baseUrl: 'https://localhost:8090', applicationId, policyId});
+ * ```
+ */
+declare const getApplicationSharingPolicy: ({ applicationId, policyId, ...config }: GetApplicationSharingPolicyConfig) => Promise<SharingPolicy>;
+export default getApplicationSharingPolicy;
+//# sourceMappingURL=getApplicationSharingPolicy.d.ts.map

package/dist/api/management/applications/getApplicationSharingPolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getApplicationSharingPolicy.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/getApplicationSharingPolicy.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,aAAa,EAAC,MAAM,gCAAgC,CAAC;AAI7D;;GAEG;AACH,MAAM,WAAW,iCAAkC,SAAQ,uBAAuB;IAChF;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,2BAA2B,GAAU,wCAIxC,iCAAiC,KAAG,OAAO,CAAC,aAAa,CAQxD,CAAC;AAEL,eAAe,2BAA2B,CAAC"}

package/dist/api/{applications → management/applications}/getApplications.d.ts

@@ -1,5 +1,5 @@
-import { ApiFilteringParams, ManagementRequestConfig } from '../../models/api';
-import { ApplicationListResponse } from '../../models/application';
+import { ApiFilteringParams, ManagementRequestConfig } from '../../../models/api';
+import { ApplicationListResponse } from '../../../models/application';
 /**
  * Configuration for the getApplications request.
  */

package/dist/api/management/applications/getApplications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getApplications.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/getApplications.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,kBAAkB,EAAE,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAC,uBAAuB,EAAC,MAAM,6BAA6B,CAAC;AAGpE;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,GAAG,IAAI,CAAC,kBAAkB,EAAE,OAAO,GAAG,QAAQ,CAAC,CAAC;AAE3G;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,eAAe,GAAU,8BAA4B,qBAAqB,KAAG,OAAO,CAAC,uBAAuB,CAO9G,CAAC;AAEL,eAAe,eAAe,CAAC"}

package/dist/api/management/applications/previewCimdDocument.d.ts

@@ -0,0 +1,15 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { CimdPreviewResponse } from '../../../models/application';
+export interface PreviewCimdDocumentConfig extends ManagementRequestConfig {
+    /**
+     * The client ID: the URL of the client's metadata document.
+     */
+    clientId: string;
+}
+/**
+ * Reads a client ID metadata document (CIMD) through the server and returns what it declares, so an
+ * application can be registered from it.
+ */
+declare const previewCimdDocument: ({ clientId, ...config }: PreviewCimdDocumentConfig) => Promise<CimdPreviewResponse>;
+export default previewCimdDocument;
+//# sourceMappingURL=previewCimdDocument.d.ts.map

package/dist/api/management/applications/previewCimdDocument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"previewCimdDocument.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/previewCimdDocument.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,mBAAmB,EAAC,MAAM,6BAA6B,CAAC;AAGhE,MAAM,WAAW,yBAA0B,SAAQ,uBAAuB;IACxE;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,QAAA,MAAM,mBAAmB,GAAU,yBAAuB,yBAAyB,KAAG,OAAO,CAAC,mBAAmB,CAa9G,CAAC;AAEJ,eAAe,mBAAmB,CAAC"}

package/dist/api/management/applications/regenerateClientSecret.d.ts

@@ -0,0 +1,28 @@
+import { AdministrationOptions } from '../../../models/administration';
+import { ManagementRequestConfig } from '../../../models/api';
+import { Application } from '../../../models/application';
+export interface RegenerateClientSecretConfig extends ManagementRequestConfig, AdministrationOptions {
+    /**
+     * Identifier of the application.
+     */
+    applicationId: string;
+}
+export interface RegenerateClientSecretResult {
+    /**
+     * The application after the change. Absent when a flow rotated the secret, since the flow does not
+     * return the application.
+     */
+    application?: Application;
+    /**
+     * The new client secret. This is the only time it can be read.
+     */
+    clientSecret: string;
+}
+/**
+ * Gives an application a new OAuth client secret. In `flow` mode the configured secret regeneration
+ * flow rotates it, revoking what the old secret was used for; otherwise a new secret is generated here
+ * and saved on the application.
+ */
+declare const regenerateClientSecret: ({ administrationMode, applicationId, ...config }: RegenerateClientSecretConfig) => Promise<RegenerateClientSecretResult>;
+export default regenerateClientSecret;
+//# sourceMappingURL=regenerateClientSecret.d.ts.map

package/dist/api/management/applications/regenerateClientSecret.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"regenerateClientSecret.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/regenerateClientSecret.ts"],"names":[],"mappings":"AAYA,OAAO,EAAC,qBAAqB,EAAC,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,WAAW,EAAoB,MAAM,6BAA6B,CAAC;AAI3E,MAAM,WAAW,4BAA6B,SAAQ,uBAAuB,EAAE,qBAAqB;IAClG;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,GAAU,kDAInC,4BAA4B,KAAG,OAAO,CAAC,4BAA4B,CAyDrE,CAAC;AAEF,eAAe,sBAAsB,CAAC"}

package/dist/api/management/applications/regenerateFlowSecret.d.ts

@@ -0,0 +1,24 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { Application } from '../../../models/application';
+export interface RegenerateFlowSecretConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the application.
+     */
+    applicationId: string;
+}
+export interface RegenerateFlowSecretResult {
+    /**
+     * The application after the change.
+     */
+    application: Application;
+    /**
+     * The new flow secret. This is the only time it can be read.
+     */
+    flowSecret: string;
+}
+/**
+ * Gives an application a new flow secret, generated here and saved on the application.
+ */
+declare const regenerateFlowSecret: ({ applicationId, ...config }: RegenerateFlowSecretConfig) => Promise<RegenerateFlowSecretResult>;
+export default regenerateFlowSecret;
+//# sourceMappingURL=regenerateFlowSecret.d.ts.map

package/dist/api/management/applications/regenerateFlowSecret.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"regenerateFlowSecret.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/regenerateFlowSecret.ts"],"names":[],"mappings":"AAKA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,WAAW,EAAC,MAAM,6BAA6B,CAAC;AAGxD,MAAM,WAAW,0BAA2B,SAAQ,uBAAuB;IACzE;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,QAAA,MAAM,oBAAoB,GAAU,8BAGjC,0BAA0B,KAAG,OAAO,CAAC,0BAA0B,CAkBjE,CAAC;AAEF,eAAe,oBAAoB,CAAC"}

package/dist/api/management/applications/suspendApplication.d.ts

@@ -0,0 +1,29 @@
+import { AccountLifecycleOptions, AccountLifecycleResult } from '../../../models/administration';
+import { ManagementRequestConfig } from '../../../models/api';
+/**
+ * Configuration for the suspendApplication request.
+ */
+export interface SuspendApplicationConfig extends ManagementRequestConfig, AccountLifecycleOptions {
+    /**
+     * Identifier of the application.
+     */
+    applicationId: string;
+}
+/**
+ * Suspends an application, so it can no longer be used to sign in or obtain tokens, through the application
+ * suspension flow the server configures. There is no management API endpoint for this, so when no flow is
+ * configured the call fails with `suspendApplication-NotConfiguredError-001`.
+ *
+ * @param config - Request configuration object. Running a flow needs `baseUrl`, and a token that may read
+ * the server configuration and run administration flows.
+ * @returns A promise that resolves with whether the flow's email step sent its notification, absent when
+ * the flow has no email step.
+ *
+ * @example
+ * ```typescript
+ * const {emailSent} = await suspendApplication({baseUrl: 'https://localhost:8090', applicationId, operatorNote: 'Ticket 4521'});
+ * ```
+ */
+declare const suspendApplication: ({ applicationId, operatorNote, ...config }: SuspendApplicationConfig) => Promise<AccountLifecycleResult>;
+export default suspendApplication;
+//# sourceMappingURL=suspendApplication.d.ts.map

package/dist/api/management/applications/suspendApplication.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suspendApplication.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/suspendApplication.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,uBAAuB,EAAE,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AAC/F,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAG5D;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB,EAAE,uBAAuB;IAChG;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,kBAAkB,GAAU,4CAI/B,wBAAwB,KAAG,OAAO,CAAC,sBAAsB,CAOxD,CAAC;AAEL,eAAe,kBAAkB,CAAC"}

package/dist/api/management/applications/unsuspendApplication.d.ts

@@ -0,0 +1,29 @@
+import { AccountLifecycleOptions, AccountLifecycleResult } from '../../../models/administration';
+import { ManagementRequestConfig } from '../../../models/api';
+/**
+ * Configuration for the unsuspendApplication request.
+ */
+export interface UnsuspendApplicationConfig extends ManagementRequestConfig, AccountLifecycleOptions {
+    /**
+     * Identifier of the application.
+     */
+    applicationId: string;
+}
+/**
+ * Lifts the suspension of an application through the application unsuspension flow the server configures.
+ * There is no management API endpoint for this, so when no flow is configured the call fails with
+ * `unsuspendApplication-NotConfiguredError-001`.
+ *
+ * @param config - Request configuration object. Running a flow needs `baseUrl`, and a token that may read
+ * the server configuration and run administration flows.
+ * @returns A promise that resolves with whether the flow's email step sent its notification, absent when
+ * the flow has no email step.
+ *
+ * @example
+ * ```typescript
+ * const {emailSent} = await unsuspendApplication({baseUrl: 'https://localhost:8090', applicationId, operatorNote: 'Ticket 4521'});
+ * ```
+ */
+declare const unsuspendApplication: ({ applicationId, operatorNote, ...config }: UnsuspendApplicationConfig) => Promise<AccountLifecycleResult>;
+export default unsuspendApplication;
+//# sourceMappingURL=unsuspendApplication.d.ts.map

package/dist/api/management/applications/unsuspendApplication.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unsuspendApplication.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/unsuspendApplication.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,uBAAuB,EAAE,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AAC/F,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAG5D;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,uBAAuB,EAAE,uBAAuB;IAClG;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,oBAAoB,GAAU,4CAIjC,0BAA0B,KAAG,OAAO,CAAC,sBAAsB,CAO1D,CAAC;AAEL,eAAe,oBAAoB,CAAC"}

package/dist/api/{applications → management/applications}/updateApplication.d.ts

@@ -1,5 +1,5 @@
-import { ManagementRequestConfig } from '../../models/api';
-import { Application, UpdateApplicationRequest } from '../../models/application';
+import { ManagementRequestConfig } from '../../../models/api';
+import { Application, UpdateApplicationRequest } from '../../../models/application';
 /**
  * Configuration for the updateApplication request.
  */

package/dist/api/management/applications/updateApplication.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateApplication.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/updateApplication.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,WAAW,EAAE,wBAAwB,EAAC,MAAM,6BAA6B,CAAC;AAGlF;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;IACtE;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,EAAE,wBAAwB,CAAC;CACnC;AAED;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,iBAAiB,GAAU,uCAAqC,uBAAuB,KAAG,OAAO,CAAC,WAAW,CAQ/G,CAAC;AAEL,eAAe,iBAAiB,CAAC"}

package/dist/api/management/applications/updateApplicationSharingPolicy.d.ts

@@ -0,0 +1,39 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { SharingPolicy, SharingPolicyUpdateRequest } from '../../../models/sharing-policy';
+/**
+ * Configuration for the updateApplicationSharingPolicy request.
+ */
+export interface UpdateApplicationSharingPolicyConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the application.
+     */
+    applicationId: string;
+    /**
+     * The policy's new sections and the version being edited.
+     */
+    payload: SharingPolicyUpdateRequest;
+    /**
+     * Identifier of the sharing policy.
+     */
+    policyId: string;
+}
+/**
+ * Replaces the sections of a sharing policy of an application. The payload names the version it edits, and
+ * an edit against any other version is refused.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the policy as the server stored it.
+ *
+ * @example
+ * ```typescript
+ * const policy = await updateApplicationSharingPolicy({
+ *   baseUrl: 'https://localhost:8090',
+ *   applicationId,
+ *   policyId,
+ *   payload: {childUnits: {mode: 'all', excludedOuIds: [ouId]}, version: 1},
+ * });
+ * ```
+ */
+declare const updateApplicationSharingPolicy: ({ applicationId, payload, policyId, ...config }: UpdateApplicationSharingPolicyConfig) => Promise<SharingPolicy>;
+export default updateApplicationSharingPolicy;
+//# sourceMappingURL=updateApplicationSharingPolicy.d.ts.map

package/dist/api/management/applications/updateApplicationSharingPolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateApplicationSharingPolicy.d.ts","sourceRoot":"","sources":["../../../../src/api/management/applications/updateApplicationSharingPolicy.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,aAAa,EAAE,0BAA0B,EAAC,MAAM,gCAAgC,CAAC;AAIzF;;GAEG;AACH,MAAM,WAAW,oCAAqC,SAAQ,uBAAuB;IACnF;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,EAAE,0BAA0B,CAAC;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,QAAA,MAAM,8BAA8B,GAAU,iDAK3C,oCAAoC,KAAG,OAAO,CAAC,aAAa,CAS3D,CAAC;AAEL,eAAe,8BAA8B,CAAC"}

package/dist/api/management/configuration/createConfigurationVersion.d.ts

@@ -0,0 +1,25 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { CaptureConfigurationVersionRequest, ConfigurationVersion } from '../../../models/configuration';
+/**
+ * Configuration for the createConfigurationVersion request.
+ */
+export interface CreateConfigurationVersionConfig extends ManagementRequestConfig {
+    /**
+     * A name and note for the version.
+     */
+    payload?: CaptureConfigurationVersionRequest;
+}
+/**
+ * Captures the current configuration as a version.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the version.
+ *
+ * @example
+ * ```typescript
+ * const version = await createConfigurationVersion({baseUrl: 'https://localhost:8090', payload: {name: 'Before launch'}});
+ * ```
+ */
+declare const createConfigurationVersion: ({ payload, ...config }: CreateConfigurationVersionConfig) => Promise<ConfigurationVersion>;
+export default createConfigurationVersion;
+//# sourceMappingURL=createConfigurationVersion.d.ts.map

package/dist/api/management/configuration/createConfigurationVersion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createConfigurationVersion.d.ts","sourceRoot":"","sources":["../../../../src/api/management/configuration/createConfigurationVersion.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,kCAAkC,EAAE,oBAAoB,EAAC,MAAM,+BAA+B,CAAC;AAGvG;;GAEG;AACH,MAAM,WAAW,gCAAiC,SAAQ,uBAAuB;IAC/E;;OAEG;IACH,OAAO,CAAC,EAAE,kCAAkC,CAAC;CAC9C;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,0BAA0B,GAAU,wBAGvC,gCAAgC,KAAG,OAAO,CAAC,oBAAoB,CAO9D,CAAC;AAEL,eAAe,0BAA0B,CAAC"}