chore(synapse): update Synapse API description and generated artifacts

Author: github-actions[bot]

libs/synapse/api-client-angular/src/lib/.openapi-generator/FILES

@@ -92,6 +92,7 @@ model/org-sagebionetworks-repo-model-acquisition-tracking-data.ts
 model/org-sagebionetworks-repo-model-act-access-requirement-interface.ts
 model/org-sagebionetworks-repo-model-act-access-requirement.ts
 model/org-sagebionetworks-repo-model-admin-expire-quarantined-email-request.ts
+model/org-sagebionetworks-repo-model-agent-add-files-to-session-request.ts
 model/org-sagebionetworks-repo-model-agent-agent-access-level.ts
 model/org-sagebionetworks-repo-model-agent-agent-chat-request.ts
 model/org-sagebionetworks-repo-model-agent-agent-chat-response.ts
@@ -100,11 +101,16 @@ model/org-sagebionetworks-repo-model-agent-agent-registration.ts
 model/org-sagebionetworks-repo-model-agent-agent-session.ts
 model/org-sagebionetworks-repo-model-agent-agent-type.ts
 model/org-sagebionetworks-repo-model-agent-create-agent-session-request.ts
+model/org-sagebionetworks-repo-model-agent-get-files-metadata-request.ts
 model/org-sagebionetworks-repo-model-agent-grid-agent-session-context.ts
 model/org-sagebionetworks-repo-model-agent-interaction.ts
 model/org-sagebionetworks-repo-model-agent-list-agent-sessions-request.ts
 model/org-sagebionetworks-repo-model-agent-list-agent-sessions-response.ts
+model/org-sagebionetworks-repo-model-agent-run-python-request.ts
 model/org-sagebionetworks-repo-model-agent-session-context.ts
+model/org-sagebionetworks-repo-model-agent-session-file-metadata-batch.ts
+model/org-sagebionetworks-repo-model-agent-session-file-metadata.ts
+model/org-sagebionetworks-repo-model-agent-session-file-to-add.ts
 model/org-sagebionetworks-repo-model-agent-session-history-request.ts
 model/org-sagebionetworks-repo-model-agent-session-history-response.ts
 model/org-sagebionetworks-repo-model-agent-table-description.ts
@@ -205,6 +211,8 @@ model/org-sagebionetworks-repo-model-curation-curation-task-properties.ts
 model/org-sagebionetworks-repo-model-curation-curation-task.ts
 model/org-sagebionetworks-repo-model-curation-execution-executable-task-execution-details.ts
 model/org-sagebionetworks-repo-model-curation-execution-grid-execution-details.ts
+model/org-sagebionetworks-repo-model-curation-execution-record-set-generation-execution-details.ts
+model/org-sagebionetworks-repo-model-curation-execution-record-set-generation-execution-properties.ts
 model/org-sagebionetworks-repo-model-curation-execution-sample-sheet-generation-execution-details.ts
 model/org-sagebionetworks-repo-model-curation-execution-sample-sheet-generation-execution-properties.ts
 model/org-sagebionetworks-repo-model-curation-list-curation-task-request.ts
@@ -547,6 +555,7 @@ model/org-sagebionetworks-repo-model-grid-synchronize-grid-request.ts
 model/org-sagebionetworks-repo-model-grid-synchronize-grid-response.ts
 model/org-sagebionetworks-repo-model-grid-update-grid-request.ts
 model/org-sagebionetworks-repo-model-grid-update-grid-response.ts
+model/org-sagebionetworks-repo-model-grid-update-grid-update-preview-response.ts
 model/org-sagebionetworks-repo-model-grid-update-grid-update-request.ts
 model/org-sagebionetworks-repo-model-grid-update-grid-update-response.ts
 model/org-sagebionetworks-repo-model-grid-update-literal-set-value.ts

libs/synapse/api-client-angular/src/lib/api/data-access-services.service.ts

@@ -655,6 +655,113 @@ export class DataAccessServicesService {
     );
   }
 
+  /**
+   * @param requestId - The ID of the data access request.
+   * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
+   * @param reportProgress flag to report request and response progress.
+   */
+  public getRepoV1DataAccessRequestRequestIdPreview(
+    requestId: string,
+    observe?: 'body',
+    reportProgress?: boolean,
+    options?: {
+      httpHeaderAccept?: 'application/json';
+      context?: HttpContext;
+      transferCache?: boolean;
+    },
+  ): Observable<OrgSagebionetworksRepoModelEducEDucFileHandleId>;
+  public getRepoV1DataAccessRequestRequestIdPreview(
+    requestId: string,
+    observe?: 'response',
+    reportProgress?: boolean,
+    options?: {
+      httpHeaderAccept?: 'application/json';
+      context?: HttpContext;
+      transferCache?: boolean;
+    },
+  ): Observable<HttpResponse<OrgSagebionetworksRepoModelEducEDucFileHandleId>>;
+  public getRepoV1DataAccessRequestRequestIdPreview(
+    requestId: string,
+    observe?: 'events',
+    reportProgress?: boolean,
+    options?: {
+      httpHeaderAccept?: 'application/json';
+      context?: HttpContext;
+      transferCache?: boolean;
+    },
+  ): Observable<HttpEvent<OrgSagebionetworksRepoModelEducEDucFileHandleId>>;
+  public getRepoV1DataAccessRequestRequestIdPreview(
+    requestId: string,
+    observe: any = 'body',
+    reportProgress: boolean = false,
+    options?: {
+      httpHeaderAccept?: 'application/json';
+      context?: HttpContext;
+      transferCache?: boolean;
+    },
+  ): Observable<any> {
+    if (requestId === null || requestId === undefined) {
+      throw new Error(
+        'Required parameter requestId was null or undefined when calling getRepoV1DataAccessRequestRequestIdPreview.',
+      );
+    }
+
+    let localVarHeaders = this.defaultHeaders;
+
+    let localVarCredential: string | undefined;
+    // authentication (bearerAuth) required
+    localVarCredential = this.configuration.lookupCredential('bearerAuth');
+    if (localVarCredential) {
+      localVarHeaders = localVarHeaders.set('Authorization', 'Bearer ' + localVarCredential);
+    }
+
+    let localVarHttpHeaderAcceptSelected: string | undefined = options && options.httpHeaderAccept;
+    if (localVarHttpHeaderAcceptSelected === undefined) {
+      // to determine the Accept header
+      const httpHeaderAccepts: string[] = ['application/json'];
+      localVarHttpHeaderAcceptSelected = this.configuration.selectHeaderAccept(httpHeaderAccepts);
+    }
+    if (localVarHttpHeaderAcceptSelected !== undefined) {
+      localVarHeaders = localVarHeaders.set('Accept', localVarHttpHeaderAcceptSelected);
+    }
+
+    let localVarHttpContext: HttpContext | undefined = options && options.context;
+    if (localVarHttpContext === undefined) {
+      localVarHttpContext = new HttpContext();
+    }
+
+    let localVarTransferCache: boolean | undefined = options && options.transferCache;
+    if (localVarTransferCache === undefined) {
+      localVarTransferCache = true;
+    }
+
+    let responseType_: 'text' | 'json' | 'blob' = 'json';
+    if (localVarHttpHeaderAcceptSelected) {
+      if (localVarHttpHeaderAcceptSelected.startsWith('text')) {
+        responseType_ = 'text';
+      } else if (this.configuration.isJsonMime(localVarHttpHeaderAcceptSelected)) {
+        responseType_ = 'json';
+      } else {
+        responseType_ = 'blob';
+      }
+    }
+
+    let localVarPath = `/repo/v1/dataAccessRequest/${this.configuration.encodeParam({ name: 'requestId', value: requestId, in: 'path', style: 'simple', explode: false, dataType: 'string', dataFormat: undefined })}/preview`;
+    return this.httpClient.request<OrgSagebionetworksRepoModelEducEDucFileHandleId>(
+      'get',
+      `${this.configuration.basePath}${localVarPath}`,
+      {
+        context: localVarHttpContext,
+        responseType: <any>responseType_,
+        withCredentials: this.configuration.withCredentials,
+        headers: localVarHeaders,
+        observe: observe,
+        transferCache: localVarTransferCache,
+        reportProgress: reportProgress,
+      },
+    );
+  }
+
   /**
    * @param requestId - The ID of the data access request.
    * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.

libs/synapse/api-client-angular/src/lib/api/user-profile-services.service.ts

@@ -827,7 +827,7 @@ export class UserProfileServicesService {
   }
 
   /**
-   * @param mask integer flag defining which components to include in the bundle    ,<p>, This integer is used as a bit-string of flags to specify which parts to include    in the UserBundle. The mask is defined as follows:  ,<ul>,  ,<li>, UserProfile  = 0x1 ,</li>,  ,<li>, ORCID  = 0x2 ,</li>,  ,<li>, VerificationSubmission  = 0x4 ,</li>,  ,<li>, IsCertified = 0x8 ,</li>,  ,<li>, Is Verified  = 0x10 ,</li>,  ,<li>, Is ACT Member = 0x20 ,</li>,  ,<li>, Is AR Reviewer = 0x40 ,</li>,  ,</ul>,  ,</p>
+   * @param mask integer flag defining which components to include in the bundle    ,<p>, This integer is used as a bit-string of flags to specify which parts to include    in the UserBundle. The mask is defined as follows:  ,<ul>,  ,<li>, UserProfile  = 0x1 ,</li>,  ,<li>, ORCID  = 0x2 ,</li>,  ,<li>, VerificationSubmission  = 0x4 ,</li>,  ,<li>, IsCertified = 0x8 ,</li>,  ,<li>, Is Verified  = 0x10 ,</li>,  ,<li>, Is ACT Member = 0x20 ,</li>,  ,<li>, Is AR Reviewer = 0x40 ,</li>,  ,<li>, Identity Providers = 0x80 ,</li>,  ,</ul>,  ,</p>
    * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
    * @param reportProgress flag to report request and response progress.
    */
@@ -1196,7 +1196,7 @@ export class UserProfileServicesService {
   }
 
   /**
-   * @param mask integer flag defining which components to include in the bundle    ,<p>, This integer is used as a bit-string of flags to specify which parts to include    in the UserBundle. The mask is defined as follows:  ,<ul>,  ,<li>, UserProfile  = 0x1 ,</li>,  ,<li>, ORCID  = 0x2 ,</li>,  ,<li>, VerificationSubmission  = 0x4 ,</li>,  ,<li>, IsCertified = 0x8 ,</li>,  ,<li>, Is Verified  = 0x10 ,</li>,  ,<li>, Is ACT Member = 0x20 ,</li>,  ,<li>, Is AR Reviewer = 0x40 ,</li>,  ,</ul>,  ,</p>
+   * @param mask integer flag defining which components to include in the bundle    ,<p>, This integer is used as a bit-string of flags to specify which parts to include    in the UserBundle. The mask is defined as follows:  ,<ul>,  ,<li>, UserProfile  = 0x1 ,</li>,  ,<li>, ORCID  = 0x2 ,</li>,  ,<li>, VerificationSubmission  = 0x4 ,</li>,  ,<li>, IsCertified = 0x8 ,</li>,  ,<li>, Is Verified  = 0x10 ,</li>,  ,<li>, Is ACT Member = 0x20 ,</li>,  ,<li>, Is AR Reviewer = 0x40 ,</li>,  ,<li>, Identity Providers = 0x80 ,</li>,  ,</ul>,  ,</p>
    * @param id
    * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
    * @param reportProgress flag to report request and response progress.

libs/synapse/api-client-angular/src/lib/model/models.ts

@@ -34,6 +34,7 @@ export * from './org-sagebionetworks-repo-model-access-requirement';
 export * from './org-sagebionetworks-repo-model-acquisition-status-names';
 export * from './org-sagebionetworks-repo-model-acquisition-tracking-data';
 export * from './org-sagebionetworks-repo-model-admin-expire-quarantined-email-request';
+export * from './org-sagebionetworks-repo-model-agent-add-files-to-session-request';
 export * from './org-sagebionetworks-repo-model-agent-agent-access-level';
 export * from './org-sagebionetworks-repo-model-agent-agent-chat-request';
 export * from './org-sagebionetworks-repo-model-agent-agent-chat-response';
@@ -42,11 +43,16 @@ export * from './org-sagebionetworks-repo-model-agent-agent-registration-request
 export * from './org-sagebionetworks-repo-model-agent-agent-session';
 export * from './org-sagebionetworks-repo-model-agent-agent-type';
 export * from './org-sagebionetworks-repo-model-agent-create-agent-session-request';
+export * from './org-sagebionetworks-repo-model-agent-get-files-metadata-request';
 export * from './org-sagebionetworks-repo-model-agent-grid-agent-session-context';
 export * from './org-sagebionetworks-repo-model-agent-interaction';
 export * from './org-sagebionetworks-repo-model-agent-list-agent-sessions-request';
 export * from './org-sagebionetworks-repo-model-agent-list-agent-sessions-response';
+export * from './org-sagebionetworks-repo-model-agent-run-python-request';
 export * from './org-sagebionetworks-repo-model-agent-session-context';
+export * from './org-sagebionetworks-repo-model-agent-session-file-metadata';
+export * from './org-sagebionetworks-repo-model-agent-session-file-metadata-batch';
+export * from './org-sagebionetworks-repo-model-agent-session-file-to-add';
 export * from './org-sagebionetworks-repo-model-agent-session-history-request';
 export * from './org-sagebionetworks-repo-model-agent-session-history-response';
 export * from './org-sagebionetworks-repo-model-agent-table-description';
@@ -147,6 +153,8 @@ export * from './org-sagebionetworks-repo-model-curation-curation-task';
 export * from './org-sagebionetworks-repo-model-curation-curation-task-properties';
 export * from './org-sagebionetworks-repo-model-curation-execution-executable-task-execution-details';
 export * from './org-sagebionetworks-repo-model-curation-execution-grid-execution-details';
+export * from './org-sagebionetworks-repo-model-curation-execution-record-set-generation-execution-details';
+export * from './org-sagebionetworks-repo-model-curation-execution-record-set-generation-execution-properties';
 export * from './org-sagebionetworks-repo-model-curation-execution-sample-sheet-generation-execution-details';
 export * from './org-sagebionetworks-repo-model-curation-execution-sample-sheet-generation-execution-properties';
 export * from './org-sagebionetworks-repo-model-curation-list-curation-task-request';
@@ -489,6 +497,7 @@ export * from './org-sagebionetworks-repo-model-grid-synchronize-grid-request';
 export * from './org-sagebionetworks-repo-model-grid-synchronize-grid-response';
 export * from './org-sagebionetworks-repo-model-grid-update-grid-request';
 export * from './org-sagebionetworks-repo-model-grid-update-grid-response';
+export * from './org-sagebionetworks-repo-model-grid-update-grid-update-preview-response';
 export * from './org-sagebionetworks-repo-model-grid-update-grid-update-request';
 export * from './org-sagebionetworks-repo-model-grid-update-grid-update-response';
 export * from './org-sagebionetworks-repo-model-grid-update-literal-set-value';

libs/synapse/api-client-angular/src/lib/model/org-sagebionetworks-repo-model-agent-add-files-to-session-request.ts

@@ -0,0 +1,20 @@
+/**
+ * Synapse REST API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { OrgSagebionetworksRepoModelAgentSessionFileToAdd } from './org-sagebionetworks-repo-model-agent-session-file-to-add';
+
+/**
+ * Request to copy one or more Synapse files into the code interpreter session so they can be inspected or processed.
+ */
+export interface OrgSagebionetworksRepoModelAgentAddFilesToSessionRequest {
+  /**
+   * The files to add, each pairing a fileHandleAssociation (from the get-files-metadata tool) with the session path where it should appear.
+   */
+  files?: Array<OrgSagebionetworksRepoModelAgentSessionFileToAdd>;
+}

libs/synapse/api-client-angular/src/lib/model/org-sagebionetworks-repo-model-agent-get-files-metadata-request.ts

@@ -0,0 +1,19 @@
+/**
+ * Synapse REST API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Request to describe the session-eligibility metadata for one or more Synapse files (each a FileEntity or RecordSet).
+ */
+export interface OrgSagebionetworksRepoModelAgentGetFilesMetadataRequest {
+  /**
+   * The FileEntity or RecordSet IDs to describe (e.g. \'syn123\' or \'syn123.5\').
+   */
+  entityIds?: Array<string>;
+}

libs/synapse/api-client-angular/src/lib/model/org-sagebionetworks-repo-model-agent-run-python-request.ts

@@ -0,0 +1,19 @@
+/**
+ * Synapse REST API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Request to execute a Python script in the current code interpreter session.
+ */
+export interface OrgSagebionetworksRepoModelAgentRunPythonRequest {
+  /**
+   * The Python script to execute. This is a JSON string value, so any control characters within the script must be escaped: newlines as \'\\n\', tabs as \'\\t\', and double quotes as \'\\\"\'.
+   */
+  script?: string;
+}

libs/synapse/api-client-angular/src/lib/model/org-sagebionetworks-repo-model-agent-session-file-metadata-batch.ts

@@ -0,0 +1,20 @@
+/**
+ * Synapse REST API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { OrgSagebionetworksRepoModelAgentSessionFileMetadata } from './org-sagebionetworks-repo-model-agent-session-file-metadata';
+
+/**
+ * The session-eligibility metadata for a batch of Synapse files, one result per requested file, in request order.
+ */
+export interface OrgSagebionetworksRepoModelAgentSessionFileMetadataBatch {
+  /**
+   * The per-file metadata, in the same order as the requested files.
+   */
+  results?: Array<OrgSagebionetworksRepoModelAgentSessionFileMetadata>;
+}

libs/synapse/api-client-angular/src/lib/model/org-sagebionetworks-repo-model-agent-session-file-metadata.ts

@@ -0,0 +1,53 @@
+/**
+ * Synapse REST API
+ *
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { OrgSagebionetworksRepoModelFileFileHandleAssociation } from './org-sagebionetworks-repo-model-file-file-handle-association';
+
+/**
+ * Metadata and code-interpreter-session eligibility for a single Synapse file (a FileEntity or RecordSet). Used by an agent to decide whether a file can be added to a session before attempting to add it, and to obtain the fileHandleAssociation that identifies the file when adding it. The file-handle contents (fileName, contentType, contentSizeBytes) and the derived isSupportedType/isWithinSizeLimit flags can only be read when the user can download the file, so they are null when canDownload is false.
+ */
+export interface OrgSagebionetworksRepoModelAgentSessionFileMetadata {
+  /**
+   * The Synapse ID of the file that was described (e.g. \'syn123\').
+   */
+  entityId?: string;
+  fileHandleAssociation?: OrgSagebionetworksRepoModelFileFileHandleAssociation;
+  /**
+   * True if the user has permission to download this file. When false, the file cannot be added to a session and the file-handle content fields are null.
+   */
+  canDownload?: boolean;
+  /**
+   * True if the file\'s type is one that can be added to a session (PDF, CSV, TXT, or JSON). Null if the user cannot download the file.
+   */
+  isSupportedType?: boolean;
+  /**
+   * True if the file is small enough to be added to a session. Null if the user cannot download the file.
+   */
+  isWithinSizeLimit?: boolean;
+  /**
+   * True only if the file can be added to a session: the user can download it, it is backed by S3 storage, its type is supported, and it is within the size limit.
+   */
+  canAddToSession?: boolean;
+  /**
+   * The name of the file. Null if the user cannot download the file.
+   */
+  fileName?: string;
+  /**
+   * The content type of the file. Null if the user cannot download the file.
+   */
+  contentType?: string;
+  /**
+   * The size of the file in bytes. Null if the user cannot download the file.
+   */
+  contentSizeBytes?: number;
+  /**
+   * A human-readable explanation of why the file cannot be added to a session, when canAddToSession is false. Null when the file can be added.
+   */
+  reason?: string;
+}