/** * Synapse REST API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: v1 * * * 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 { RestrictableObjectDescriptor } from './RestrictableObjectDescriptor'; /** * JSON schema for out of band 'Access Control Team' controlled Access Requirement, a 'tier 3' Access Requirement. This access requirement directs user to contact an ACT member to gain access to the data. * @export * @interface ACTAccessRequirement */ export interface ACTAccessRequirement { /** * The version number issued to this version on the object. * @type {number} * @memberof ACTAccessRequirement */ versionNumber?: number; /** * The unique immutable ID. Provided by the system, the user may not set this field. * @type {number} * @memberof ACTAccessRequirement */ id?: number; /** * Depricated. Replaced by name. * @type {string} * @memberof ACTAccessRequirement */ description?: string; /** * Name of the AR. Limited to 50 characters and must be unique. Required. * @type {string} * @memberof ACTAccessRequirement */ name?: string; /** * Synapse employs an Optimistic Concurrency Control (OCC) scheme to handle concurrent updates. Since the E-Tag changes every time an entity is updated it is used to detect when a client's current representation of an object is out-of-date. * @type {string} * @memberof ACTAccessRequirement */ etag?: string; /** * The date this object was created. Provided by the system, the user may not set this field. * @type {string} * @memberof ACTAccessRequirement */ createdOn?: string; /** * The date this object was last modified. Provided by the system, the user may not set this field. * @type {string} * @memberof ACTAccessRequirement */ modifiedOn?: string; /** * The user that created this object. Provided by the system, the user may not set this field. * @type {string} * @memberof ACTAccessRequirement */ createdBy?: string; /** * The user that last modified this object. Provided by the system, the user may not set this field. * @type {string} * @memberof ACTAccessRequirement */ modifiedBy?: string; /** * Defaults to 'false'. When 'true', the subjects controlled by this AR are defined by the the'_accessRequirementIds' annotations on individual entities. This property is mutually exclusive with 'subjectIds'. If this is set to 'true' then 'subjectIds' must be excluded or empty. * @type {boolean} * @memberof ACTAccessRequirement */ subjectsDefinedByAnnotations?: boolean; /** * The IDs of the items controlled by this Access Requirement when 'subjectsDefinedByAnnotations=false'. This property is mutually exclusive with 'subjectsDefinedByAnnotations'. When 'subjectsDefinedByAnnotations=true' then this property must be empty or excluded. Required when creating or updating and 'subjectsDefinedByAnnotations=false' or 'subjectsDefinedByAnnotations' is excluded. * @type {Array} * @memberof ACTAccessRequirement */ subjectIds?: Array; /** * The enumeration of possible permission. * @type {string} * @memberof ACTAccessRequirement */ accessType?: ACTAccessRequirementAccessTypeEnum; /** * Indicates which type of AccessRequirement this object represents. Provided by the system, the user may not set this field. * @type {string} * @memberof ACTAccessRequirement */ concreteType: ACTAccessRequirementConcreteTypeEnum; /** * Information on how to contact the Synapse ACT for access approval (external to Synapse). Required when creating or updating. * @type {string} * @memberof ACTAccessRequirement */ actContactInfo?: string; /** * If true, then in addition to following directions in the 'actContactInfo' the client should open a JIRA issue to notify the ACT. If omitted, default is 'true'. * @type {boolean} * @memberof ACTAccessRequirement */ openJiraIssue?: boolean; } /** * @export */ export declare const ACTAccessRequirementAccessTypeEnum: { readonly CREATE: "CREATE"; readonly READ: "READ"; readonly UPDATE: "UPDATE"; readonly DELETE: "DELETE"; readonly CHANGE_PERMISSIONS: "CHANGE_PERMISSIONS"; readonly DOWNLOAD: "DOWNLOAD"; readonly UPLOAD: "UPLOAD"; readonly PARTICIPATE: "PARTICIPATE"; readonly SUBMIT: "SUBMIT"; readonly READ_PRIVATE_SUBMISSION: "READ_PRIVATE_SUBMISSION"; readonly UPDATE_SUBMISSION: "UPDATE_SUBMISSION"; readonly DELETE_SUBMISSION: "DELETE_SUBMISSION"; readonly TEAM_MEMBERSHIP_UPDATE: "TEAM_MEMBERSHIP_UPDATE"; readonly SEND_MESSAGE: "SEND_MESSAGE"; readonly CHANGE_SETTINGS: "CHANGE_SETTINGS"; readonly MODERATE: "MODERATE"; readonly REVIEW_SUBMISSIONS: "REVIEW_SUBMISSIONS"; readonly EXEMPTION_ELIGIBLE: "EXEMPTION_ELIGIBLE"; }; export type ACTAccessRequirementAccessTypeEnum = typeof ACTAccessRequirementAccessTypeEnum[keyof typeof ACTAccessRequirementAccessTypeEnum]; /** * @export */ export declare const ACTAccessRequirementConcreteTypeEnum: { readonly org_sagebionetworks_repo_model_ACTAccessRequirement: "org.sagebionetworks.repo.model.ACTAccessRequirement"; }; export type ACTAccessRequirementConcreteTypeEnum = typeof ACTAccessRequirementConcreteTypeEnum[keyof typeof ACTAccessRequirementConcreteTypeEnum]; /** * Check if a given object implements the ACTAccessRequirement interface. */ export declare function instanceOfACTAccessRequirement(value: object): value is ACTAccessRequirement; export declare function ACTAccessRequirementFromJSON(json: any): ACTAccessRequirement; export declare function ACTAccessRequirementFromJSONTyped(json: any, ignoreDiscriminator: boolean): ACTAccessRequirement; export declare function ACTAccessRequirementToJSON(json: any): ACTAccessRequirement; export declare function ACTAccessRequirementToJSONTyped(value?: ACTAccessRequirement | null, ignoreDiscriminator?: boolean): any;