@openfilz-sdk/typescript-ee 1.13.3 → 1.14.0

package/dist/api/sharing-policy-api.d.ts

@@ -0,0 +1,662 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { EffectivePolicy } from '../models';
+import type { GlobalPolicy } from '../models';
+import type { MyPolicy } from '../models';
+import type { OverrideRequest } from '../models';
+import type { OverrideView } from '../models';
+import type { RevokeRequest } from '../models';
+import type { RevokeResult } from '../models';
+import type { ViolationsResponse } from '../models';
+/**
+ * SharingPolicyApi - axios parameter creator
+ */
+export declare const SharingPolicyApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminGetEffectiveSharingPolicy: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminGetSharingPolicy: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Progress of a background revocation
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminGetSharingPolicyRevokeJob: (jobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Users and teams with their own sharing rule
+     * @param {string} [type]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminListSharingPolicyOverrides: (type?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
+     * @summary Existing shares the current policies refuse
+     * @param {string} [cursor]
+     * @param {number} [size]
+     * @param {boolean} [count]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminListSharingPolicyViolations: (cursor?: string, size?: number, count?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
+     * @param {string} subjectId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminRemoveSharingPolicyOverride: (subjectId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
+     * @summary Revoke shares that break the policy
+     * @param {RevokeRequest} revokeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminRevokeSharingPolicyViolations: (revokeRequest: RevokeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
+     * @summary Change the global mode, allowed domains and e-Sign switch
+     * @param {GlobalPolicy} globalPolicy
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminSetSharingPolicyGlobal: (globalPolicy: GlobalPolicy, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
+     * @summary Set a user\'s or a team\'s sharing rule
+     * @param {string} subjectId
+     * @param {OverrideRequest} overrideRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminSetSharingPolicyOverride: (subjectId: string, overrideRequest: OverrideRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEffectiveSharingPolicy: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * The allowed domains are listed only when the rule restricts domains.
+     * @summary The caller\'s own sharing rule (for the share dialog)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMySharingPolicy: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSharingPolicy: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Progress of a background revocation
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSharingPolicyRevokeJob: (jobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Users and teams with their own sharing rule
+     * @param {string} [type]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSharingPolicyOverrides: (type?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
+     * @summary Existing shares the current policies refuse
+     * @param {string} [cursor]
+     * @param {number} [size]
+     * @param {boolean} [count]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSharingPolicyViolations: (cursor?: string, size?: number, count?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
+     * @param {string} subjectId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeSharingPolicyOverride: (subjectId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
+     * @summary Revoke shares that break the policy
+     * @param {RevokeRequest} revokeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revokeSharingPolicyViolations: (revokeRequest: RevokeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
+     * @summary Change the global mode, allowed domains and e-Sign switch
+     * @param {GlobalPolicy} globalPolicy
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setSharingPolicyGlobal: (globalPolicy: GlobalPolicy, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
+     * @summary Set a user\'s or a team\'s sharing rule
+     * @param {string} subjectId
+     * @param {OverrideRequest} overrideRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setSharingPolicyOverride: (subjectId: string, overrideRequest: OverrideRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * SharingPolicyApi - functional programming interface
+ */
+export declare const SharingPolicyApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminGetEffectiveSharingPolicy(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EffectivePolicy>>;
+    /**
+     *
+     * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminGetSharingPolicy(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GlobalPolicy>>;
+    /**
+     *
+     * @summary Progress of a background revocation
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminGetSharingPolicyRevokeJob(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeResult>>;
+    /**
+     *
+     * @summary Users and teams with their own sharing rule
+     * @param {string} [type]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminListSharingPolicyOverrides(type?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OverrideView>>>;
+    /**
+     * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
+     * @summary Existing shares the current policies refuse
+     * @param {string} [cursor]
+     * @param {number} [size]
+     * @param {boolean} [count]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminListSharingPolicyViolations(cursor?: string, size?: number, count?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ViolationsResponse>>;
+    /**
+     *
+     * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
+     * @param {string} subjectId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminRemoveSharingPolicyOverride(subjectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
+     * @summary Revoke shares that break the policy
+     * @param {RevokeRequest} revokeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminRevokeSharingPolicyViolations(revokeRequest: RevokeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeResult>>;
+    /**
+     * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
+     * @summary Change the global mode, allowed domains and e-Sign switch
+     * @param {GlobalPolicy} globalPolicy
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminSetSharingPolicyGlobal(globalPolicy: GlobalPolicy, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GlobalPolicy>>;
+    /**
+     * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
+     * @summary Set a user\'s or a team\'s sharing rule
+     * @param {string} subjectId
+     * @param {OverrideRequest} overrideRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminSetSharingPolicyOverride(subjectId: string, overrideRequest: OverrideRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OverrideView>>;
+    /**
+     *
+     * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEffectiveSharingPolicy(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EffectivePolicy>>;
+    /**
+     * The allowed domains are listed only when the rule restricts domains.
+     * @summary The caller\'s own sharing rule (for the share dialog)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMySharingPolicy(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MyPolicy>>;
+    /**
+     *
+     * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSharingPolicy(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GlobalPolicy>>;
+    /**
+     *
+     * @summary Progress of a background revocation
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSharingPolicyRevokeJob(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeResult>>;
+    /**
+     *
+     * @summary Users and teams with their own sharing rule
+     * @param {string} [type]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSharingPolicyOverrides(type?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<OverrideView>>>;
+    /**
+     * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
+     * @summary Existing shares the current policies refuse
+     * @param {string} [cursor]
+     * @param {number} [size]
+     * @param {boolean} [count]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSharingPolicyViolations(cursor?: string, size?: number, count?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ViolationsResponse>>;
+    /**
+     *
+     * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
+     * @param {string} subjectId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeSharingPolicyOverride(subjectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
+     * @summary Revoke shares that break the policy
+     * @param {RevokeRequest} revokeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revokeSharingPolicyViolations(revokeRequest: RevokeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeResult>>;
+    /**
+     * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
+     * @summary Change the global mode, allowed domains and e-Sign switch
+     * @param {GlobalPolicy} globalPolicy
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setSharingPolicyGlobal(globalPolicy: GlobalPolicy, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GlobalPolicy>>;
+    /**
+     * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
+     * @summary Set a user\'s or a team\'s sharing rule
+     * @param {string} subjectId
+     * @param {OverrideRequest} overrideRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setSharingPolicyOverride(subjectId: string, overrideRequest: OverrideRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OverrideView>>;
+};
+/**
+ * SharingPolicyApi - factory interface
+ */
+export declare const SharingPolicyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminGetEffectiveSharingPolicy(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<EffectivePolicy>;
+    /**
+     *
+     * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminGetSharingPolicy(options?: RawAxiosRequestConfig): AxiosPromise<GlobalPolicy>;
+    /**
+     *
+     * @summary Progress of a background revocation
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminGetSharingPolicyRevokeJob(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<RevokeResult>;
+    /**
+     *
+     * @summary Users and teams with their own sharing rule
+     * @param {string} [type]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminListSharingPolicyOverrides(type?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OverrideView>>;
+    /**
+     * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
+     * @summary Existing shares the current policies refuse
+     * @param {string} [cursor]
+     * @param {number} [size]
+     * @param {boolean} [count]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminListSharingPolicyViolations(cursor?: string, size?: number, count?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<ViolationsResponse>;
+    /**
+     *
+     * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
+     * @param {string} subjectId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminRemoveSharingPolicyOverride(subjectId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
+     * @summary Revoke shares that break the policy
+     * @param {RevokeRequest} revokeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminRevokeSharingPolicyViolations(revokeRequest: RevokeRequest, options?: RawAxiosRequestConfig): AxiosPromise<RevokeResult>;
+    /**
+     * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
+     * @summary Change the global mode, allowed domains and e-Sign switch
+     * @param {GlobalPolicy} globalPolicy
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminSetSharingPolicyGlobal(globalPolicy: GlobalPolicy, options?: RawAxiosRequestConfig): AxiosPromise<GlobalPolicy>;
+    /**
+     * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
+     * @summary Set a user\'s or a team\'s sharing rule
+     * @param {string} subjectId
+     * @param {OverrideRequest} overrideRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminSetSharingPolicyOverride(subjectId: string, overrideRequest: OverrideRequest, options?: RawAxiosRequestConfig): AxiosPromise<OverrideView>;
+    /**
+     *
+     * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEffectiveSharingPolicy(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<EffectivePolicy>;
+    /**
+     * The allowed domains are listed only when the rule restricts domains.
+     * @summary The caller\'s own sharing rule (for the share dialog)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMySharingPolicy(options?: RawAxiosRequestConfig): AxiosPromise<MyPolicy>;
+    /**
+     *
+     * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSharingPolicy(options?: RawAxiosRequestConfig): AxiosPromise<GlobalPolicy>;
+    /**
+     *
+     * @summary Progress of a background revocation
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSharingPolicyRevokeJob(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<RevokeResult>;
+    /**
+     *
+     * @summary Users and teams with their own sharing rule
+     * @param {string} [type]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSharingPolicyOverrides(type?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<OverrideView>>;
+    /**
+     * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
+     * @summary Existing shares the current policies refuse
+     * @param {string} [cursor]
+     * @param {number} [size]
+     * @param {boolean} [count]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSharingPolicyViolations(cursor?: string, size?: number, count?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<ViolationsResponse>;
+    /**
+     *
+     * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
+     * @param {string} subjectId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeSharingPolicyOverride(subjectId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
+     * @summary Revoke shares that break the policy
+     * @param {RevokeRequest} revokeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revokeSharingPolicyViolations(revokeRequest: RevokeRequest, options?: RawAxiosRequestConfig): AxiosPromise<RevokeResult>;
+    /**
+     * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
+     * @summary Change the global mode, allowed domains and e-Sign switch
+     * @param {GlobalPolicy} globalPolicy
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setSharingPolicyGlobal(globalPolicy: GlobalPolicy, options?: RawAxiosRequestConfig): AxiosPromise<GlobalPolicy>;
+    /**
+     * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
+     * @summary Set a user\'s or a team\'s sharing rule
+     * @param {string} subjectId
+     * @param {OverrideRequest} overrideRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setSharingPolicyOverride(subjectId: string, overrideRequest: OverrideRequest, options?: RawAxiosRequestConfig): AxiosPromise<OverrideView>;
+};
+/**
+ * SharingPolicyApi - object-oriented interface
+ */
+export declare class SharingPolicyApi extends BaseAPI {
+    /**
+     *
+     * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminGetEffectiveSharingPolicy(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EffectivePolicy, any, {}, any>>;
+    /**
+     *
+     * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminGetSharingPolicy(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GlobalPolicy, any, {}, any>>;
+    /**
+     *
+     * @summary Progress of a background revocation
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminGetSharingPolicyRevokeJob(jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeResult, any, {}, any>>;
+    /**
+     *
+     * @summary Users and teams with their own sharing rule
+     * @param {string} [type]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminListSharingPolicyOverrides(type?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OverrideView[], any, {}, any>>;
+    /**
+     * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
+     * @summary Existing shares the current policies refuse
+     * @param {string} [cursor]
+     * @param {number} [size]
+     * @param {boolean} [count]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminListSharingPolicyViolations(cursor?: string, size?: number, count?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ViolationsResponse, any, {}, any>>;
+    /**
+     *
+     * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
+     * @param {string} subjectId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminRemoveSharingPolicyOverride(subjectId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
+    /**
+     * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
+     * @summary Revoke shares that break the policy
+     * @param {RevokeRequest} revokeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminRevokeSharingPolicyViolations(revokeRequest: RevokeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeResult, any, {}, any>>;
+    /**
+     * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
+     * @summary Change the global mode, allowed domains and e-Sign switch
+     * @param {GlobalPolicy} globalPolicy
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminSetSharingPolicyGlobal(globalPolicy: GlobalPolicy, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GlobalPolicy, any, {}, any>>;
+    /**
+     * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
+     * @summary Set a user\'s or a team\'s sharing rule
+     * @param {string} subjectId
+     * @param {OverrideRequest} overrideRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    adminSetSharingPolicyOverride(subjectId: string, overrideRequest: OverrideRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OverrideView, any, {}, any>>;
+    /**
+     *
+     * @summary A user\'s effective sharing rule and where it comes from (USER, TEAM or GLOBAL)
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEffectiveSharingPolicy(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EffectivePolicy, any, {}, any>>;
+    /**
+     * The allowed domains are listed only when the rule restricts domains.
+     * @summary The caller\'s own sharing rule (for the share dialog)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMySharingPolicy(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MyPolicy, any, {}, any>>;
+    /**
+     *
+     * @summary The global mode, allowed domains, e-Sign switch, locked keys and number of overrides
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSharingPolicy(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GlobalPolicy, any, {}, any>>;
+    /**
+     *
+     * @summary Progress of a background revocation
+     * @param {string} jobId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSharingPolicyRevokeJob(jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeResult, any, {}, any>>;
+    /**
+     *
+     * @summary Users and teams with their own sharing rule
+     * @param {string} [type]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSharingPolicyOverrides(type?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OverrideView[], any, {}, any>>;
+    /**
+     * Keyset-paginated (pass nextCursor back as cursor). A document\'s name is given only when the caller can already read it. count=true answers {count} only (cached 60 s).
+     * @summary Existing shares the current policies refuse
+     * @param {string} [cursor]
+     * @param {number} [size]
+     * @param {boolean} [count]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSharingPolicyViolations(cursor?: string, size?: number, count?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ViolationsResponse, any, {}, any>>;
+    /**
+     *
+     * @summary Remove a user\'s or a team\'s own rule (back to their teams\', else the global mode)
+     * @param {string} subjectId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeSharingPolicyOverride(subjectId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
+    /**
+     * items: the rows to revoke (each re-checked; a row that complies is skipped), or all=true. Each revocation is audited under the caller and notified to the document\'s owner. Above 500 rows, all=true runs in the background: 202 with a jobId to poll.
+     * @summary Revoke shares that break the policy
+     * @param {RevokeRequest} revokeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revokeSharingPolicyViolations(revokeRequest: RevokeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeResult, any, {}, any>>;
+    /**
+     * Writes only the three openfilz.sharing.external.* settings (audited ADMIN_SETTING_CHANGED; 409 when the deployment locks one). A DOMAIN mode needs at least one domain. The answer carries the number of existing shares that no longer comply (violations).
+     * @summary Change the global mode, allowed domains and e-Sign switch
+     * @param {GlobalPolicy} globalPolicy
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setSharingPolicyGlobal(globalPolicy: GlobalPolicy, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GlobalPolicy, any, {}, any>>;
+    /**
+     * A user\'s rule wins over their teams\'; several teams combine by union of their conditions; ALLOW on a team exempts its members from the global mode. Audited SHARING_POLICY_CHANGED. 404 outside the caller\'s organisation.
+     * @summary Set a user\'s or a team\'s sharing rule
+     * @param {string} subjectId
+     * @param {OverrideRequest} overrideRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setSharingPolicyOverride(subjectId: string, overrideRequest: OverrideRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OverrideView, any, {}, any>>;
+}