@wix/auto_sdk_containers_projects 1.0.25 → 1.0.26

package/build/internal/cjs/index.typings.d.ts

@@ -242,102 +242,205 @@ interface ProjectPlanReady {
     conversationId?: string;
 }
 interface AcquireWorkerReportingRequest {
-    /** @format GUID */
+    /**
+     * Project ID.
+     * @format GUID
+     */
     projectId?: string;
-    /** @maxLength 4096 */
+    /**
+     * Token that the worker received when it started. Valid until it expires.
+     *
+     * Each exchange returns a new credential and invalidates the previous one.
+     * @maxLength 4096
+     */
     bootstrapToken?: string;
 }
 interface AcquireWorkerReportingResponse {
-    /** @maxLength 256 */
+    /**
+     * Reporting credential. Specify it in later calls to this service.
+     * @maxLength 256
+     */
     credential?: string;
-    /** @format GUID */
+    /**
+     * ID of the reporting session.
+     * @format GUID
+     */
     sessionId?: string;
-    /** @format GUID */
+    /**
+     * Project ID.
+     * @format GUID
+     */
     projectId?: string;
-    /** @format GUID */
+    /**
+     * ID of the Wix site that the project belongs to.
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** @format GUID */
+    /**
+     * ID of the site user who started the work.
+     * @format GUID
+     */
     initiatingUserId?: string;
-    /** @maxLength 256 */
+    /**
+     * Identity that reports are created under.
+     * @maxLength 256
+     */
     reporterPrincipal?: string;
+    /** Number of seconds until the credential expires. */
     expiresIn?: string;
 }
 interface RenewWorkerReportingRequest {
-    /** @format GUID */
+    /**
+     * Project ID.
+     * @format GUID
+     */
     projectId?: string;
-    /** @maxLength 256 */
+    /**
+     * Reporting credential to renew.
+     * @maxLength 256
+     */
     credential?: string;
 }
 interface RenewWorkerReportingResponse {
+    /** Number of seconds until the renewed credential expires. */
     expiresIn?: string;
-    /** @maxLength 4096 */
+    /**
+     * Site access token for the user who started the work.
+     * @maxLength 4096
+     */
     siteAccessToken?: string;
+    /** Number of seconds until the site access token expires. */
     siteTokenExpiresIn?: string;
 }
 interface BeginWorkerReportingRunRequest extends BeginWorkerReportingRunRequestJobIdPresenceOneOf {
-    /** @format GUID */
+    /**
+     * ID of the project job to link the run to.
+     * @format GUID
+     */
     jobId?: string;
-    /** @format GUID */
+    /**
+     * Project ID.
+     * @format GUID
+     */
     projectId?: string;
-    /** @maxLength 256 */
+    /**
+     * Reporting credential.
+     * @maxLength 256
+     */
     credential?: string;
-    /** @format GUID */
+    /**
+     * ID of the run to start.
+     * @format GUID
+     */
     runId?: string;
 }
 /** @oneof */
 interface BeginWorkerReportingRunRequestJobIdPresenceOneOf {
-    /** @format GUID */
+    /**
+     * ID of the project job to link the run to.
+     * @format GUID
+     */
     jobId?: string;
 }
 interface BeginWorkerReportingRunResponse extends BeginWorkerReportingRunResponseJobIdPresenceOneOf {
-    /** @format GUID */
+    /**
+     * ID of the project job that the run is linked to. Returned only when the run is linked to a job.
+     * @format GUID
+     */
     jobId?: string;
-    /** @format GUID */
+    /**
+     * ID of the run.
+     * @format GUID
+     */
     runId?: string;
-    /** @format GUID */
+    /**
+     * Project ID.
+     * @format GUID
+     */
     projectId?: string;
-    /** @format GUID */
+    /**
+     * ID of the Wix site that the project belongs to.
+     * @format GUID
+     */
     metaSiteId?: string;
-    /** @format GUID */
+    /**
+     * ID of the site user who started the work.
+     * @format GUID
+     */
     initiatingUserId?: string;
 }
 /** @oneof */
 interface BeginWorkerReportingRunResponseJobIdPresenceOneOf {
-    /** @format GUID */
+    /**
+     * ID of the project job that the run is linked to. Returned only when the run is linked to a job.
+     * @format GUID
+     */
     jobId?: string;
 }
 interface BindWorkerReportingJobRequest {
-    /** @format GUID */
+    /**
+     * Project ID.
+     * @format GUID
+     */
     projectId?: string;
-    /** @maxLength 256 */
+    /**
+     * Reporting credential.
+     * @maxLength 256
+     */
     credential?: string;
-    /** @format GUID */
+    /**
+     * ID of the run to link.
+     * @format GUID
+     */
     runId?: string;
-    /** @format GUID */
+    /**
+     * ID of the project job to link the run to.
+     * @format GUID
+     */
     jobId?: string;
 }
 interface BindWorkerReportingJobResponse {
-    /** @format GUID */
+    /**
+     * ID of the project job that the run is linked to.
+     * @format GUID
+     */
     jobId?: string;
 }
 interface RevokeWorkerReportingRequest {
-    /** @format GUID */
+    /**
+     * Project ID.
+     * @format GUID
+     */
     projectId?: string;
-    /** @maxLength 256 */
+    /**
+     * Reporting credential to revoke.
+     * @maxLength 256
+     */
     credential?: string;
 }
 interface RevokeWorkerReportingResponse {
 }
 interface CreateWorkerReportRequest {
+    /** Run that the operation belongs to, and the credential that authenticates it. */
     scope?: WorkerReportingScope;
+    /** Operation to perform. */
     operation?: CreateReportRequest;
 }
 interface WorkerReportingScope {
-    /** @format GUID */
+    /**
+     * Project ID.
+     * @format GUID
+     */
     projectId?: string;
-    /** @format GUID */
+    /**
+     * ID of the reporting run.
+     * @format GUID
+     */
     runId?: string;
-    /** @maxLength 256 */
+    /**
+     * Reporting credential returned by Acquire Worker Reporting.
+     * @maxLength 256
+     */
     credential?: string;
 }
 /** CreateReport request. */
@@ -579,6 +682,7 @@ declare enum RelationType {
 /** @enumType */
 type RelationTypeWithLiterals = RelationType | 'ADDITIONAL_DATA' | 'CORRECTION';
 interface CreateWorkerReportResponse {
+    /** Result of the operation. */
     result?: CreateReportResponse;
 }
 /** CreateReport response. */
@@ -587,7 +691,9 @@ interface CreateReportResponse {
     report?: Report;
 }
 interface GetWorkerReportRequest {
+    /** Run that the operation belongs to, and the credential that authenticates it. */
     scope?: WorkerReportingScope;
+    /** Operation to perform. */
     operation?: GetReportRequest;
 }
 /** GetReport request. */
@@ -599,6 +705,7 @@ interface GetReportRequest {
     reportId?: string;
 }
 interface GetWorkerReportResponse {
+    /** Result of the operation. */
     result?: GetReportResponse;
 }
 /** GetReport response. */
@@ -607,7 +714,9 @@ interface GetReportResponse {
     report?: Report;
 }
 interface AddWorkerReportUpdateRequest {
+    /** Run that the operation belongs to, and the credential that authenticates it. */
     scope?: WorkerReportingScope;
+    /** Operation to perform. */
     operation?: AddReportUpdateRequest;
 }
 /** AddReportUpdate request. */
@@ -701,6 +810,7 @@ declare enum UpdateAction {
 /** @enumType */
 type UpdateActionWithLiterals = UpdateAction | 'CREATED' | 'REPAIR_ATTEMPT' | 'EXPLANATION_CORRECTION' | 'EVIDENCE_ADDED' | 'CLASSIFICATION_CHANGED' | 'CONTENT_FINISHED' | 'JOB_ATTACHED' | 'EXPIRATION_CHANGED';
 interface AddWorkerReportUpdateResponse {
+    /** Result of the operation. */
     result?: AddReportUpdateResponse;
 }
 /** AddReportUpdate response. */
@@ -778,7 +888,9 @@ interface ReportUpdateAttachedJobIdPresenceOneOf {
     attachedJobId?: string;
 }
 interface FinishWorkerReportRequest {
+    /** Run that the operation belongs to, and the credential that authenticates it. */
     scope?: WorkerReportingScope;
+    /** Operation to perform. */
     operation?: FinishReportRequest;
 }
 /** FinishReport request. */
@@ -797,6 +909,7 @@ interface FinishReportRequest {
     expectedRevision?: string;
 }
 interface FinishWorkerReportResponse {
+    /** Result of the operation. */
     result?: FinishReportResponse;
 }
 /** FinishReport response. */
@@ -805,7 +918,9 @@ interface FinishReportResponse {
     report?: Report;
 }
 interface AttachWorkerReportToJobRequest {
+    /** Run that the operation belongs to, and the credential that authenticates it. */
     scope?: WorkerReportingScope;
+    /** Operation to perform. */
     operation?: AttachReportToJobRequest;
 }
 /** AttachReportToJob request. */
@@ -829,6 +944,7 @@ interface AttachReportToJobRequest {
     jobId?: string;
 }
 interface AttachWorkerReportToJobResponse {
+    /** Result of the operation. */
     result?: AttachReportToJobResponse;
 }
 /** AttachReportToJob response. */
@@ -837,7 +953,9 @@ interface AttachReportToJobResponse {
     report?: Report;
 }
 interface BeginWorkerReportContentRequest {
+    /** Run that the operation belongs to, and the credential that authenticates it. */
     scope?: WorkerReportingScope;
+    /** Operation to perform. */
     operation?: BeginReportContentRequest;
 }
 /** BeginReportContent request. */
@@ -901,6 +1019,7 @@ declare enum ContentKind {
 /** @enumType */
 type ContentKindWithLiterals = ContentKind | 'PROMPT' | 'CONVERSATION' | 'LOG' | 'METADATA';
 interface BeginWorkerReportContentResponse {
+    /** Result of the operation. */
     result?: BeginReportContentResponse;
 }
 /** BeginReportContent response. */
@@ -951,7 +1070,9 @@ declare enum UploadState {
 /** @enumType */
 type UploadStateWithLiterals = UploadState | 'UPLOADING' | 'COMPLETE' | 'TRANSFER_FAILED';
 interface UploadWorkerReportContentChunkRequest {
+    /** Run that the operation belongs to, and the credential that authenticates it. */
     scope?: WorkerReportingScope;
+    /** Operation to perform. */
     operation?: UploadReportContentChunkRequest;
 }
 /** UploadReportContentChunk request. */
@@ -972,6 +1093,7 @@ interface UploadReportContentChunkRequest {
     data?: Uint8Array;
 }
 interface UploadWorkerReportContentChunkResponse {
+    /** Result of the operation. */
     result?: UploadReportContentChunkResponse;
 }
 /** UploadReportContentChunk response. */
@@ -980,7 +1102,9 @@ interface UploadReportContentChunkResponse {
     content?: ReportContent;
 }
 interface CompleteWorkerReportContentRequest {
+    /** Run that the operation belongs to, and the credential that authenticates it. */
     scope?: WorkerReportingScope;
+    /** Operation to perform. */
     operation?: CompleteReportContentRequest;
 }
 /** CompleteReportContent request. */
@@ -997,6 +1121,7 @@ interface CompleteReportContentRequest {
     requestId?: string;
 }
 interface CompleteWorkerReportContentResponse {
+    /** Result of the operation. */
     result?: CompleteReportContentResponse;
 }
 /** CompleteReportContent response. */