@thunderid/javascript 1.6.0 → 1.7.0

package/dist/api/management/users/updateUserSharingPolicy.d.ts

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

package/dist/api/management/users/updateUserSharingPolicy.d.ts.map

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

package/dist/api/management/variables/createVariable.d.ts

@@ -0,0 +1,25 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { Variable, VariableRequest } from '../../../models/variable-store';
+/**
+ * Configuration for the createVariable request.
+ */
+export interface CreateVariableConfig extends ManagementRequestConfig {
+    /**
+     * The variable to add.
+     */
+    payload: VariableRequest;
+}
+/**
+ * Adds a variable.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the variable as the server stored it.
+ *
+ * @example
+ * ```typescript
+ * const variable = await createVariable({baseUrl: 'https://localhost:8090', payload: {name: 'SMTP_HOST', value}});
+ * ```
+ */
+declare const createVariable: ({ payload, ...config }: CreateVariableConfig) => Promise<Variable>;
+export default createVariable;
+//# sourceMappingURL=createVariable.d.ts.map

package/dist/api/management/variables/createVariable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createVariable.d.ts","sourceRoot":"","sources":["../../../../src/api/management/variables/createVariable.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,QAAQ,EAAE,eAAe,EAAC,MAAM,gCAAgC,CAAC;AAGzE;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB;IACnE;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC;CAC1B;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,cAAc,GAAU,wBAAsB,oBAAoB,KAAG,OAAO,CAAC,QAAQ,CAOvF,CAAC;AAEL,eAAe,cAAc,CAAC"}

package/dist/api/management/variables/deleteVariable.d.ts

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

package/dist/api/management/variables/deleteVariable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteVariable.d.ts","sourceRoot":"","sources":["../../../../src/api/management/variables/deleteVariable.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAG5D;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB;IACnE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,cAAc,GAAU,qBAAmB,oBAAoB,KAAG,OAAO,CAAC,IAAI,CAQnF,CAAC;AAEF,eAAe,cAAc,CAAC"}

package/dist/api/management/variables/getVariable.d.ts

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

package/dist/api/management/variables/getVariable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getVariable.d.ts","sourceRoot":"","sources":["../../../../src/api/management/variables/getVariable.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,QAAQ,EAAC,MAAM,gCAAgC,CAAC;AAGxD;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;IAChE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,WAAW,GAAU,qBAAmB,iBAAiB,KAAG,OAAO,CAAC,QAAQ,CAO9E,CAAC;AAEL,eAAe,WAAW,CAAC"}

package/dist/api/management/variables/getVariables.d.ts

@@ -0,0 +1,25 @@
+import { ApiFilteringParams, ManagementRequestConfig } from '../../../models/api';
+import { VariableListResponse } from '../../../models/variable-store';
+/**
+ * Configuration for the getVariables request.
+ */
+export interface GetVariablesConfig extends ManagementRequestConfig, ApiFilteringParams {
+    /**
+     * Returns only these names (at most 100). A name with nothing stored is absent from the result.
+     */
+    names?: string[];
+}
+/**
+ * Retrieves a page of variables.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the page the server returned.
+ *
+ * @example
+ * ```typescript
+ * const {variables} = await getVariables({baseUrl: 'https://localhost:8090', names: ['SMTP_HOST']});
+ * ```
+ */
+declare const getVariables: ({ filter, limit, names, offset, ...config }: GetVariablesConfig) => Promise<VariableListResponse>;
+export default getVariables;
+//# sourceMappingURL=getVariables.d.ts.map

package/dist/api/management/variables/getVariables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getVariables.d.ts","sourceRoot":"","sources":["../../../../src/api/management/variables/getVariables.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,kBAAkB,EAAE,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAC,oBAAoB,EAAC,MAAM,gCAAgC,CAAC;AAGpE;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB,EAAE,kBAAkB;IACrF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,YAAY,GAAU,6CAMzB,kBAAkB,KAAG,OAAO,CAAC,oBAAoB,CAOhD,CAAC;AAEL,eAAe,YAAY,CAAC"}

package/dist/api/management/variables/updateVariable.d.ts

@@ -0,0 +1,29 @@
+import { ManagementRequestConfig } from '../../../models/api';
+import { Variable, VariableUpdateRequest } from '../../../models/variable-store';
+/**
+ * Configuration for the updateVariable request.
+ */
+export interface UpdateVariableConfig extends ManagementRequestConfig {
+    /**
+     * Name of the variable.
+     */
+    name: string;
+    /**
+     * The variable's new value.
+     */
+    payload: VariableUpdateRequest;
+}
+/**
+ * Sets or replaces a variable, creating it when it does not exist.
+ *
+ * @param config - Request configuration object.
+ * @returns A promise that resolves with the variable as the server stored it.
+ *
+ * @example
+ * ```typescript
+ * const variable = await updateVariable({baseUrl: 'https://localhost:8090', name: 'SMTP_HOST', payload: {value}});
+ * ```
+ */
+declare const updateVariable: ({ name, payload, ...config }: UpdateVariableConfig) => Promise<Variable>;
+export default updateVariable;
+//# sourceMappingURL=updateVariable.d.ts.map

package/dist/api/management/variables/updateVariable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateVariable.d.ts","sourceRoot":"","sources":["../../../../src/api/management/variables/updateVariable.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,uBAAuB,EAAC,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAC,QAAQ,EAAE,qBAAqB,EAAC,MAAM,gCAAgC,CAAC;AAG/E;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,uBAAuB;IACnE;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,qBAAqB,CAAC;CAChC;AAED;;;;;;;;;;GAUG;AACH,QAAA,MAAM,cAAc,GAAU,8BAA4B,oBAAoB,KAAG,OAAO,CAAC,QAAQ,CAQ7F,CAAC;AAEL,eAAe,cAAc,CAAC"}