@thunderid/javascript 1.12.0 → 1.13.0

package/dist/api/management/client-registrations/registerClient.d.ts

@@ -0,0 +1,31 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { ClientRegistration, ClientRegistrationRequest } from '../../../models/client-registration';
+/**
+ * Configuration for the registerClient request.
+ */
+export interface RegisterClientConfig extends ManagementRequestConfig {
+    /**
+     * The client metadata to register.
+     */
+    payload: ClientRegistrationRequest;
+}
+/**
+ * Registers an OAuth 2.0 client through dynamic client registration (RFC 7591).
+ *
+ * The result carries the client secret. This is the only time it is returned: it cannot be read
+ * back afterwards, so store it securely and never log it.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the registration, including the client secret.
+ *
+ * @example
+ * ```typescript
+ * const {clientId, clientSecret} = await registerClient({
+ *   baseUrl: 'https://localhost:8090',
+ *   payload: {clientName: 'My App', redirectUris: ['https://myapp.example.com/callback']},
+ * });
+ * ```
+ */
+declare const registerClient: ({ payload, ...config }: RegisterClientConfig) => Promise<ClientRegistration>;
+export default registerClient;
+//# sourceMappingURL=registerClient.d.ts.map

package/dist/api/management/client-registrations/registerClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registerClient.d.ts","sourceRoot":"","sources":["../../../../src/api/management/client-registrations/registerClient.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,kBAAkB,EAAE,yBAAyB,EAAC,MAAM,qCAAqC,CAAC;AAGlG;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB;IACnE;;OAEG;IACH,OAAO,EAAE,yBAAyB,CAAC;CACpC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,QAAA,MAAM,cAAc,GAAU,wBAAsB,oBAAoB,KAAG,OAAO,CAAC,kBAAkB,CASlG,CAAC;AAEJ,eAAe,cAAc,CAAC"}

package/dist/api/management/client-registrations/updateClientRegistration.d.ts

@@ -0,0 +1,34 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { ClientRegistration, ClientRegistrationUpdateRequest } from '../../../models/client-registration';
+/**
+ * Configuration for the updateClientRegistration request.
+ */
+export interface UpdateClientRegistrationConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the registered client.
+     */
+    clientId: string;
+    /**
+     * The client's new metadata. Replaces the registered metadata in full: omitted fields are not kept.
+     */
+    payload: ClientRegistrationUpdateRequest;
+}
+/**
+ * Replaces the registration of a dynamically registered client (RFC 7592). The request carries
+ * `client_id`, set from `clientId`; the client ID and secret are kept.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the updated registration.
+ *
+ * @example
+ * ```typescript
+ * const registration = await updateClientRegistration({
+ *   baseUrl: 'https://localhost:8090',
+ *   clientId,
+ *   payload: {clientName: 'My Renamed App', redirectUris: ['https://myapp.example.com/callback2']},
+ * });
+ * ```
+ */
+declare const updateClientRegistration: ({ clientId, payload, ...config }: UpdateClientRegistrationConfig) => Promise<ClientRegistration>;
+export default updateClientRegistration;
+//# sourceMappingURL=updateClientRegistration.d.ts.map

package/dist/api/management/client-registrations/updateClientRegistration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateClientRegistration.d.ts","sourceRoot":"","sources":["../../../../src/api/management/client-registrations/updateClientRegistration.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,kBAAkB,EAAE,+BAA+B,EAAC,MAAM,qCAAqC,CAAC;AAGxG;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,uBAAuB;IAC7E;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,+BAA+B,CAAC;CAC1C;AAED;;;;;;;;;;;;;;;GAeG;AACH,QAAA,MAAM,wBAAwB,GAAU,kCAIrC,8BAA8B,KAAG,OAAO,CAAC,kBAAkB,CAU3D,CAAC;AAEJ,eAAe,wBAAwB,CAAC"}

package/dist/api/management/credential-configurations/createCredentialConfiguration.d.ts

@@ -0,0 +1,25 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { CredentialConfiguration, CredentialConfigurationRequest } from '../../../models/credential-configuration';
+/**
+ * Configuration for the createCredentialConfiguration request.
+ */
+export interface CreateCredentialConfigurationConfig extends ManagementRequestConfig {
+    /**
+     * The credential configuration to create.
+     */
+    payload: CredentialConfigurationRequest;
+}
+/**
+ * Creates a credential configuration.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the credential configuration as the server stored it.
+ *
+ * @example
+ * ```typescript
+ * const item = await createCredentialConfiguration({baseUrl: 'https://localhost:8090', payload: {handle: 'pid', ouId, vct: 'urn:example:pid:1'}});
+ * ```
+ */
+declare const createCredentialConfiguration: ({ payload, ...config }: CreateCredentialConfigurationConfig) => Promise<CredentialConfiguration>;
+export default createCredentialConfiguration;
+//# sourceMappingURL=createCredentialConfiguration.d.ts.map

package/dist/api/management/credential-configurations/createCredentialConfiguration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createCredentialConfiguration.d.ts","sourceRoot":"","sources":["../../../../src/api/management/credential-configurations/createCredentialConfiguration.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,uBAAuB,EAAE,8BAA8B,EAAC,MAAM,0CAA0C,CAAC;AAGjH;;GAEG;AACH,MAAM,WAAW,mCAAoC,SAAQ,uBAAuB;IAClF;;OAEG;IACH,OAAO,EAAE,8BAA8B,CAAC;CACzC;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,6BAA6B,GAAU,wBAG1C,mCAAmC,KAAG,OAAO,CAAC,uBAAuB,CAOpE,CAAC;AAEL,eAAe,6BAA6B,CAAC"}

package/dist/api/management/credential-configurations/deleteCredentialConfiguration.d.ts

@@ -0,0 +1,24 @@
+import { ManagementRequestConfig } from '../../../models/api';
+/**
+ * Configuration for the deleteCredentialConfiguration request.
+ */
+export interface DeleteCredentialConfigurationConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the credential configuration.
+     */
+    configurationId: string;
+}
+/**
+ * Deletes a credential configuration. Deleting one that does not exist succeeds.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves once the server has made the change.
+ *
+ * @example
+ * ```typescript
+ * await deleteCredentialConfiguration({baseUrl: 'https://localhost:8090', configurationId});
+ * ```
+ */
+declare const deleteCredentialConfiguration: ({ configurationId, ...config }: DeleteCredentialConfigurationConfig) => Promise<void>;
+export default deleteCredentialConfiguration;
+//# sourceMappingURL=deleteCredentialConfiguration.d.ts.map

package/dist/api/management/credential-configurations/deleteCredentialConfiguration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteCredentialConfiguration.d.ts","sourceRoot":"","sources":["../../../../src/api/management/credential-configurations/deleteCredentialConfiguration.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAG5D;;GAEG;AACH,MAAM,WAAW,mCAAoC,SAAQ,uBAAuB;IAClF;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,6BAA6B,GAAU,gCAG1C,mCAAmC,KAAG,OAAO,CAAC,IAAI,CAQpD,CAAC;AAEF,eAAe,6BAA6B,CAAC"}

package/dist/api/management/credential-configurations/getCredentialConfiguration.d.ts

@@ -0,0 +1,25 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { CredentialConfiguration } from '../../../models/credential-configuration';
+/**
+ * Configuration for the getCredentialConfiguration request.
+ */
+export interface GetCredentialConfigurationConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the credential configuration.
+     */
+    configurationId: string;
+}
+/**
+ * Retrieves a credential configuration.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the credential configuration.
+ *
+ * @example
+ * ```typescript
+ * const item = await getCredentialConfiguration({baseUrl: 'https://localhost:8090', configurationId});
+ * ```
+ */
+declare const getCredentialConfiguration: ({ configurationId, ...config }: GetCredentialConfigurationConfig) => Promise<CredentialConfiguration>;
+export default getCredentialConfiguration;
+//# sourceMappingURL=getCredentialConfiguration.d.ts.map

package/dist/api/management/credential-configurations/getCredentialConfiguration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCredentialConfiguration.d.ts","sourceRoot":"","sources":["../../../../src/api/management/credential-configurations/getCredentialConfiguration.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,uBAAuB,EAAC,MAAM,0CAA0C,CAAC;AAGjF;;GAEG;AACH,MAAM,WAAW,gCAAiC,SAAQ,uBAAuB;IAC/E;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,0BAA0B,GAAU,gCAGvC,gCAAgC,KAAG,OAAO,CAAC,uBAAuB,CAOjE,CAAC;AAEL,eAAe,0BAA0B,CAAC"}

package/dist/api/management/credential-configurations/getCredentialConfigurations.d.ts

@@ -0,0 +1,20 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { CredentialConfigurationSummary } from '../../../models/credential-configuration';
+/**
+ * Configuration for the getCredentialConfigurations request.
+ */
+export type GetCredentialConfigurationsConfig = ManagementRequestConfig;
+/**
+ * Retrieves the credential configurations.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the credential configurations.
+ *
+ * @example
+ * ```typescript
+ * const configurations = await getCredentialConfigurations({baseUrl: 'https://localhost:8090'});
+ * ```
+ */
+declare const getCredentialConfigurations: (config: GetCredentialConfigurationsConfig) => Promise<CredentialConfigurationSummary[]>;
+export default getCredentialConfigurations;
+//# sourceMappingURL=getCredentialConfigurations.d.ts.map

package/dist/api/management/credential-configurations/getCredentialConfigurations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCredentialConfigurations.d.ts","sourceRoot":"","sources":["../../../../src/api/management/credential-configurations/getCredentialConfigurations.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,8BAA8B,EAAC,MAAM,0CAA0C,CAAC;AAGxF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,uBAAuB,CAAC;AAExE;;;;;;;;;;GAUG;AACH,QAAA,MAAM,2BAA2B,GAC/B,QAAQ,iCAAiC,KACxC,OAAO,CAAC,8BAA8B,EAAE,CAMvC,CAAC;AAEL,eAAe,2BAA2B,CAAC"}

package/dist/api/management/credential-configurations/updateCredentialConfiguration.d.ts

@@ -0,0 +1,29 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { CredentialConfiguration, CredentialConfigurationRequest } from '../../../models/credential-configuration';
+/**
+ * Configuration for the updateCredentialConfiguration request.
+ */
+export interface UpdateCredentialConfigurationConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the credential configuration.
+     */
+    configurationId: string;
+    /**
+     * The credential configuration's new content. Replaces the stored one.
+     */
+    payload: CredentialConfigurationRequest;
+}
+/**
+ * Replaces a credential configuration.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the credential configuration as the server stored it.
+ *
+ * @example
+ * ```typescript
+ * const item = await updateCredentialConfiguration({baseUrl: 'https://localhost:8090', configurationId, payload});
+ * ```
+ */
+declare const updateCredentialConfiguration: ({ configurationId, payload, ...config }: UpdateCredentialConfigurationConfig) => Promise<CredentialConfiguration>;
+export default updateCredentialConfiguration;
+//# sourceMappingURL=updateCredentialConfiguration.d.ts.map

package/dist/api/management/credential-configurations/updateCredentialConfiguration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateCredentialConfiguration.d.ts","sourceRoot":"","sources":["../../../../src/api/management/credential-configurations/updateCredentialConfiguration.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,uBAAuB,EAAE,8BAA8B,EAAC,MAAM,0CAA0C,CAAC;AAGjH;;GAEG;AACH,MAAM,WAAW,mCAAoC,SAAQ,uBAAuB;IAClF;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,OAAO,EAAE,8BAA8B,CAAC;CACzC;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,6BAA6B,GAAU,yCAI1C,mCAAmC,KAAG,OAAO,CAAC,uBAAuB,CAQpE,CAAC;AAEL,eAAe,6BAA6B,CAAC"}

package/dist/api/management/flows/createFlowSharingPolicy.d.ts

@@ -0,0 +1,33 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { SharingPolicy, SharingPolicyRequest } from '../../../models/sharing-policy';
+/**
+ * Configuration for the createFlowSharingPolicy request.
+ */
+export interface CreateFlowSharingPolicyConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the flow.
+     */
+    flowId: string;
+    /**
+     * The policy to create.
+     */
+    payload: SharingPolicyRequest;
+}
+/**
+ * Creates a sharing policy for a flow: 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 createFlowSharingPolicy({
+ *   baseUrl: 'https://localhost:8090',
+ *   flowId,
+ *   payload: {childUnits: {mode: 'all'}},
+ * });
+ * ```
+ */
+declare const createFlowSharingPolicy: ({ flowId, payload, ...config }: CreateFlowSharingPolicyConfig) => Promise<SharingPolicy>;
+export default createFlowSharingPolicy;
+//# sourceMappingURL=createFlowSharingPolicy.d.ts.map

package/dist/api/management/flows/createFlowSharingPolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createFlowSharingPolicy.d.ts","sourceRoot":"","sources":["../../../../src/api/management/flows/createFlowSharingPolicy.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,6BAA8B,SAAQ,uBAAuB;IAC5E;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,oBAAoB,CAAC;CAC/B;AAED;;;;;;;;;;;;;;GAcG;AACH,QAAA,MAAM,uBAAuB,GAAU,gCAIpC,6BAA6B,KAAG,OAAO,CAAC,aAAa,CASpD,CAAC;AAEL,eAAe,uBAAuB,CAAC"}

package/dist/api/management/flows/deleteFlowSharingPolicy.d.ts

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

package/dist/api/management/flows/deleteFlowSharingPolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteFlowSharingPolicy.d.ts","sourceRoot":"","sources":["../../../../src/api/management/flows/deleteFlowSharingPolicy.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAI5D;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,uBAAuB,GAAU,iCAA+B,6BAA6B,KAAG,OAAO,CAAC,IAAI,CASjH,CAAC;AAEF,eAAe,uBAAuB,CAAC"}

package/dist/api/management/flows/getFlowOverlayRules.d.ts

@@ -0,0 +1,31 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { FlowResolvedOverlay } from '../../../models/sharing-policy';
+/**
+ * Configuration for the getFlowOverlayRules request.
+ */
+export interface GetFlowOverlayRulesConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the flow.
+     */
+    flowId: string;
+    /**
+     * Identifier of the organization unit to resolve the rules for.
+     */
+    ouId: string;
+}
+/**
+ * Retrieves what an organization unit may do with a flow: whether it owns or can see it, and the effective
+ * rule for each variable, keyed `variables.<identifier>`. An organization unit no policy reaches gets a
+ * not-found error.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the resolved overlay.
+ *
+ * @example
+ * ```typescript
+ * const {rules} = await getFlowOverlayRules({baseUrl: 'https://localhost:8090', flowId, ouId});
+ * ```
+ */
+declare const getFlowOverlayRules: ({ flowId, ouId, ...config }: GetFlowOverlayRulesConfig) => Promise<FlowResolvedOverlay>;
+export default getFlowOverlayRules;
+//# sourceMappingURL=getFlowOverlayRules.d.ts.map

package/dist/api/management/flows/getFlowOverlayRules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFlowOverlayRules.d.ts","sourceRoot":"","sources":["../../../../src/api/management/flows/getFlowOverlayRules.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,mBAAmB,EAAC,MAAM,gCAAgC,CAAC;AAGnE;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,uBAAuB;IACxE;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;;;GAYG;AACH,QAAA,MAAM,mBAAmB,GAAU,6BAIhC,yBAAyB,KAAG,OAAO,CAAC,mBAAmB,CAStD,CAAC;AAEL,eAAe,mBAAmB,CAAC"}

package/dist/api/management/flows/getFlowSharingPolicies.d.ts

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

package/dist/api/management/flows/getFlowSharingPolicies.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFlowSharingPolicies.d.ts","sourceRoot":"","sources":["../../../../src/api/management/flows/getFlowSharingPolicies.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,4BACf,SAAQ,uBAAuB,EAC7B,IAAI,CAAC,kBAAkB,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC9C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,sBAAsB,GAAU,sCAKnC,4BAA4B,KAAG,OAAO,CAAC,yBAAyB,CAS/D,CAAC;AAEL,eAAe,sBAAsB,CAAC"}

package/dist/api/management/flows/getFlowSharingPolicy.d.ts

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

package/dist/api/management/flows/getFlowSharingPolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFlowSharingPolicy.d.ts","sourceRoot":"","sources":["../../../../src/api/management/flows/getFlowSharingPolicy.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,aAAa,EAAC,MAAM,gCAAgC,CAAC;AAI7D;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,uBAAuB;IACzE;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,oBAAoB,GAAU,iCAIjC,0BAA0B,KAAG,OAAO,CAAC,aAAa,CAQjD,CAAC;AAEL,eAAe,oBAAoB,CAAC"}

package/dist/api/management/flows/getFlowVariables.d.ts

@@ -0,0 +1,31 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { FlowVariables } from '../../../models/managed-flow';
+/**
+ * Configuration for the getFlowVariables request.
+ */
+export interface GetFlowVariablesConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the flow.
+     */
+    flowId: string;
+    /**
+     * Identifier of the organization unit whose values are read. The flow has to be owned by, or shared
+     * with, it.
+     */
+    ouId: string;
+}
+/**
+ * Retrieves the values an organization unit has set for a flow's variables. The value in force for a
+ * variable is this override, or else its `defaultValue` from `getFlow`.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the unit's values, keyed by variable identifier.
+ *
+ * @example
+ * ```typescript
+ * const {values} = await getFlowVariables({baseUrl: 'https://localhost:8090', flowId, ouId});
+ * ```
+ */
+declare const getFlowVariables: ({ flowId, ouId, ...config }: GetFlowVariablesConfig) => Promise<FlowVariables>;
+export default getFlowVariables;
+//# sourceMappingURL=getFlowVariables.d.ts.map

package/dist/api/management/flows/getFlowVariables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFlowVariables.d.ts","sourceRoot":"","sources":["../../../../src/api/management/flows/getFlowVariables.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,aAAa,EAAC,MAAM,8BAA8B,CAAC;AAG3D;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,uBAAuB;IACrE;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,gBAAgB,GAAU,6BAA2B,sBAAsB,KAAG,OAAO,CAAC,aAAa,CASrG,CAAC;AAEL,eAAe,gBAAgB,CAAC"}

package/dist/api/management/flows/updateFlowSharingPolicy.d.ts

@@ -0,0 +1,39 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { SharingPolicy, SharingPolicyUpdateRequest } from '../../../models/sharing-policy';
+/**
+ * Configuration for the updateFlowSharingPolicy request.
+ */
+export interface UpdateFlowSharingPolicyConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the flow.
+     */
+    flowId: 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 a flow. 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 updateFlowSharingPolicy({
+ *   baseUrl: 'https://localhost:8090',
+ *   flowId,
+ *   policyId,
+ *   payload: {childUnits: {mode: 'all', excludedOuIds: [ouId]}, version: 1},
+ * });
+ * ```
+ */
+declare const updateFlowSharingPolicy: ({ flowId, payload, policyId, ...config }: UpdateFlowSharingPolicyConfig) => Promise<SharingPolicy>;
+export default updateFlowSharingPolicy;
+//# sourceMappingURL=updateFlowSharingPolicy.d.ts.map

package/dist/api/management/flows/updateFlowSharingPolicy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateFlowSharingPolicy.d.ts","sourceRoot":"","sources":["../../../../src/api/management/flows/updateFlowSharingPolicy.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,6BAA8B,SAAQ,uBAAuB;IAC5E;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,0BAA0B,CAAC;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,QAAA,MAAM,uBAAuB,GAAU,0CAKpC,6BAA6B,KAAG,OAAO,CAAC,aAAa,CASpD,CAAC;AAEL,eAAe,uBAAuB,CAAC"}

package/dist/api/management/flows/updateFlowVariables.d.ts

@@ -0,0 +1,41 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { FlowVariableValue, FlowVariables } from '../../../models/managed-flow';
+/**
+ * Configuration for the updateFlowVariables request.
+ */
+export interface UpdateFlowVariablesConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the flow.
+     */
+    flowId: string;
+    /**
+     * Identifier of the organization unit whose values are set. The flow has to be owned by, or shared
+     * with, it.
+     */
+    ouId: string;
+    /**
+     * The value of each variable to set, keyed by identifier. The set replaces what the unit held, so a
+     * variable left out returns to its default.
+     */
+    variables: Record<string, FlowVariableValue>;
+}
+/**
+ * Replaces the values an organization unit holds for a flow's variables. Every value is validated before
+ * any is written.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the unit's values after the change.
+ *
+ * @example
+ * ```typescript
+ * const {values} = await updateFlowVariables({
+ *   baseUrl: 'https://localhost:8090',
+ *   flowId,
+ *   ouId,
+ *   variables: {supportEmail: 'help@example.com', showRegistrationLink: true},
+ * });
+ * ```
+ */
+declare const updateFlowVariables: ({ flowId, ouId, variables, ...config }: UpdateFlowVariablesConfig) => Promise<FlowVariables>;
+export default updateFlowVariables;
+//# sourceMappingURL=updateFlowVariables.d.ts.map

package/dist/api/management/flows/updateFlowVariables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateFlowVariables.d.ts","sourceRoot":"","sources":["../../../../src/api/management/flows/updateFlowVariables.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,iBAAiB,EAAE,aAAa,EAAC,MAAM,8BAA8B,CAAC;AAG9E;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,uBAAuB;IACxE;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;CAC9C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,QAAA,MAAM,mBAAmB,GAAU,wCAKhC,yBAAyB,KAAG,OAAO,CAAC,aAAa,CAShD,CAAC;AAEL,eAAe,mBAAmB,CAAC"}

package/dist/api/management/gateways/getGatewayMaster.d.ts

@@ -0,0 +1,25 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { GatewayMaster } from '../../../models/gateway';
+/**
+ * Configuration for the getGatewayMaster request.
+ */
+export interface GetGatewayMasterConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the gateway.
+     */
+    gatewayId: string;
+}
+/**
+ * Retrieves a gateway's latest master: every resource deployed to it, as the gateway last accepted it.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the master.
+ *
+ * @example
+ * ```typescript
+ * const {entries} = await getGatewayMaster({baseUrl: 'https://localhost:8090', gatewayId});
+ * ```
+ */
+declare const getGatewayMaster: ({ gatewayId, ...config }: GetGatewayMasterConfig) => Promise<GatewayMaster>;
+export default getGatewayMaster;
+//# sourceMappingURL=getGatewayMaster.d.ts.map

package/dist/api/management/gateways/getGatewayMaster.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getGatewayMaster.d.ts","sourceRoot":"","sources":["../../../../src/api/management/gateways/getGatewayMaster.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,aAAa,EAAC,MAAM,yBAAyB,CAAC;AAGtD;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,uBAAuB;IACrE;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,gBAAgB,GAAU,0BAAwB,sBAAsB,KAAG,OAAO,CAAC,aAAa,CAQlG,CAAC;AAEL,eAAe,gBAAgB,CAAC"}

package/dist/api/management/gateways/getGatewayMasterHistory.d.ts

@@ -0,0 +1,26 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { GatewayMaster } from '../../../models/gateway';
+/**
+ * Configuration for the getGatewayMasterHistory request.
+ */
+export interface GetGatewayMasterHistoryConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the gateway.
+     */
+    gatewayId: string;
+}
+/**
+ * Retrieves the masters kept for a gateway, newest first, each with its summary but without its
+ * entries or resources.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the masters.
+ *
+ * @example
+ * ```typescript
+ * const masters = await getGatewayMasterHistory({baseUrl: 'https://localhost:8090', gatewayId});
+ * ```
+ */
+declare const getGatewayMasterHistory: ({ gatewayId, ...config }: GetGatewayMasterHistoryConfig) => Promise<GatewayMaster[]>;
+export default getGatewayMasterHistory;
+//# sourceMappingURL=getGatewayMasterHistory.d.ts.map

package/dist/api/management/gateways/getGatewayMasterHistory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getGatewayMasterHistory.d.ts","sourceRoot":"","sources":["../../../../src/api/management/gateways/getGatewayMasterHistory.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,aAAa,EAAC,MAAM,yBAAyB,CAAC;AAGtD;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC5E;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;;GAWG;AACH,QAAA,MAAM,uBAAuB,GAAU,0BAGpC,6BAA6B,KAAG,OAAO,CAAC,aAAa,EAAE,CAQtD,CAAC;AAEL,eAAe,uBAAuB,CAAC"}

package/dist/api/management/gateways/getGatewayMasterResource.d.ts

@@ -0,0 +1,39 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { GatewayResourceHistory } from '../../../models/gateway';
+/**
+ * Configuration for the getGatewayMasterResource request.
+ */
+export interface GetGatewayMasterResourceConfig extends ManagementRequestConfig {
+    /**
+     * Identifier of the gateway.
+     */
+    gatewayId: string;
+    /**
+     * The resource's id, the part of a master entry's `key` after the slash.
+     */
+    resourceId: string;
+    /**
+     * The resource type, the part of a master entry's `key` before the slash.
+     */
+    resourceType: string;
+}
+/**
+ * Retrieves one resource's history on a gateway: its entry in each kept master that records it,
+ * newest first.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the resource's history.
+ *
+ * @example
+ * ```typescript
+ * const {history} = await getGatewayMasterResource({
+ *   baseUrl: 'https://localhost:8090',
+ *   gatewayId,
+ *   resourceId: 'app-1',
+ *   resourceType: 'application',
+ * });
+ * ```
+ */
+declare const getGatewayMasterResource: ({ gatewayId, resourceId, resourceType, ...config }: GetGatewayMasterResourceConfig) => Promise<GatewayResourceHistory>;
+export default getGatewayMasterResource;
+//# sourceMappingURL=getGatewayMasterResource.d.ts.map

package/dist/api/management/gateways/getGatewayMasterResource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getGatewayMasterResource.d.ts","sourceRoot":"","sources":["../../../../src/api/management/gateways/getGatewayMasterResource.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,sBAAsB,EAAC,MAAM,yBAAyB,CAAC;AAI/D;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,uBAAuB;IAC7E;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,QAAA,MAAM,wBAAwB,GAAU,oDAKrC,8BAA8B,KAAG,OAAO,CAAC,sBAAsB,CAQ9D,CAAC;AAEL,eAAe,wBAAwB,CAAC"}