@wix/auto_sdk_containers_project-jobs 1.0.0

package/build/internal/es/index.d.mts

@@ -0,0 +1,141 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { ProjectJob, GetCurrentProjectJobResponse, JobStatusWithLiterals, UpdateProjectJobStatusOptions, UpdateProjectJobStatusResponse, ClearProjectJobAssistantResponseResponse, CancelProjectJobResponse, GetLatestProjectJobResponse, CreateSuggestionsJobOptions, CreateSuggestionsJobResponse, OpenProjectJobActivityResponse, ActivityBatch, ReportProjectJobActivityResponse, QueryProjectJobActivityOptions, QueryProjectJobActivityResponse, ProjectJobQuery, QueryProjectJobsOptions, typedQueryProjectJobs, ProjectJobsQueryBuilder } from './index.typings.mjs';
+export { AccountInfo, ActionEvent, ActivityEvent, ActivityEventType, ActivityEventTypeWithLiterals, ActivitySource, ActivitySourceWithLiterals, ActivityWorkflow, ActivityWorkflowWithLiterals, Attachment, AttachmentType, AttachmentTypeWithLiterals, CancelProjectJobRequest, ClearProjectJobAssistantResponseRequest, CommonQueryWithEntityContext, CreateProjectJobRequest, CreateProjectJobResponse, CreateSuggestionsJobRequest, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, GetCurrentProjectJobRequest, GetLatestProjectJobRequest, GetProjectJobRequest, GetProjectJobResponse, IdentificationData, IdentificationDataIdOneOf, JobStatus, JobType, JobTypeWithLiterals, MessageEnvelope, OpenProjectJobActivityRequest, Platform, PlatformWithLiterals, ProjectJobQuerySpec, ProjectJobsQueryResult, QueryProjectJobActivityRequest, QueryProjectJobsRequest, QueryProjectJobsResponse, ReportProjectJobActivityRequest, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, Suggestion, UpdateProjectJobStatusRequest, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.mjs';
+
+/** @internal */
+declare function createProjectJob$1(httpClient: HttpClient): CreateProjectJobSignature;
+interface CreateProjectJobSignature {
+    /**
+     * Creates a new ProjectJob.
+     * @param - ProjectJob to be created.
+     * @returns The created ProjectJob.
+     */
+    (projectJob: NonNullablePaths<ProjectJob, `platform` | `projectId` | `prompt`, 0>): Promise<NonNullablePaths<ProjectJob, `projectId` | `jobType` | `platform` | `jobStatus` | `prompt` | `attachments` | `attachments.${number}.type` | `attachments.${number}.url` | `attachments.${number}.displayName` | `codingAgentSessionId` | `failureReason` | `creditsExempt` | `creditsCostUsd` | `suggestions` | `suggestions.${number}.label` | `suggestions.${number}.prompt`, 2>>;
+}
+/** @internal */
+declare function getProjectJob$1(httpClient: HttpClient): GetProjectJobSignature;
+interface GetProjectJobSignature {
+    /**
+     * Retrieves a ProjectJob by ID.
+     * @param - ID of the ProjectJob to retrieve.
+     * @returns The requested ProjectJob.
+     */
+    (projectJobId: string): Promise<NonNullablePaths<ProjectJob, `projectId` | `jobType` | `platform` | `jobStatus` | `prompt` | `attachments` | `attachments.${number}.type` | `attachments.${number}.url` | `attachments.${number}.displayName` | `codingAgentSessionId` | `failureReason` | `creditsExempt` | `creditsCostUsd` | `suggestions` | `suggestions.${number}.label` | `suggestions.${number}.prompt`, 2>>;
+}
+/** @internal */
+declare function getCurrentProjectJob$1(httpClient: HttpClient): GetCurrentProjectJobSignature;
+interface GetCurrentProjectJobSignature {
+    /**
+     * Gets the highest-priority job that the agent should work on next.
+     * @param - ID of the project to get the current job for.
+     */
+    (projectId: string): Promise<NonNullablePaths<GetCurrentProjectJobResponse, `projectJob.projectId` | `projectJob.jobType` | `projectJob.platform` | `projectJob.jobStatus` | `projectJob.prompt` | `projectJob.attachments` | `projectJob.attachments.${number}.type` | `projectJob.attachments.${number}.url` | `projectJob.attachments.${number}.displayName` | `projectJob.codingAgentSessionId` | `projectJob.failureReason` | `projectJob.creditsExempt` | `projectJob.creditsCostUsd` | `projectJob.suggestions` | `projectJob.suggestions.${number}.label` | `projectJob.suggestions.${number}.prompt`, 3>>;
+}
+/** @internal */
+declare function updateProjectJobStatus$1(httpClient: HttpClient): UpdateProjectJobStatusSignature;
+interface UpdateProjectJobStatusSignature {
+    /**
+     * Updates the status of a job with state-machine enforcement.
+     * @param - ID of the job to update.
+     * @param - New status for the job.
+     */
+    (projectJobId: string, jobStatus: JobStatusWithLiterals, options?: NonNullablePaths<UpdateProjectJobStatusOptions, `revision`, 0>): Promise<NonNullablePaths<UpdateProjectJobStatusResponse, `projectJob.projectId` | `projectJob.jobType` | `projectJob.platform` | `projectJob.jobStatus` | `projectJob.prompt` | `projectJob.attachments` | `projectJob.attachments.${number}.type` | `projectJob.attachments.${number}.url` | `projectJob.attachments.${number}.displayName` | `projectJob.codingAgentSessionId` | `projectJob.failureReason` | `projectJob.creditsExempt` | `projectJob.creditsCostUsd` | `projectJob.suggestions` | `projectJob.suggestions.${number}.label` | `projectJob.suggestions.${number}.prompt`, 3>>;
+}
+/** @internal */
+declare function clearProjectJobAssistantResponse$1(httpClient: HttpClient): ClearProjectJobAssistantResponseSignature;
+interface ClearProjectJobAssistantResponseSignature {
+    /**
+     * Drops a job's assistant answer once it has reached the conversation it was meant for. Called by
+     * containers-projects after a successful chat write, so the job does not keep a second, indefinite
+     * copy of user-visible text that Chat already stores under its own retention rules.
+     * @param - ID of the job whose delivered answer should be dropped.
+     */
+    (projectJobId: string): Promise<NonNullablePaths<ClearProjectJobAssistantResponseResponse, `projectJob.projectId` | `projectJob.jobType` | `projectJob.platform` | `projectJob.jobStatus` | `projectJob.prompt` | `projectJob.attachments` | `projectJob.attachments.${number}.type` | `projectJob.attachments.${number}.url` | `projectJob.attachments.${number}.displayName` | `projectJob.codingAgentSessionId` | `projectJob.failureReason` | `projectJob.creditsExempt` | `projectJob.creditsCostUsd` | `projectJob.suggestions` | `projectJob.suggestions.${number}.label` | `projectJob.suggestions.${number}.prompt`, 3>>;
+}
+/** @internal */
+declare function cancelProjectJob$1(httpClient: HttpClient): CancelProjectJobSignature;
+interface CancelProjectJobSignature {
+    /**
+     * Cancels a pending job.
+     * @param - ID of the job to cancel.
+     * @param - Current revision for optimistic locking.
+     */
+    (projectJobId: string, revision: string): Promise<NonNullablePaths<CancelProjectJobResponse, `projectJob.projectId` | `projectJob.jobType` | `projectJob.platform` | `projectJob.jobStatus` | `projectJob.prompt` | `projectJob.attachments` | `projectJob.attachments.${number}.type` | `projectJob.attachments.${number}.url` | `projectJob.attachments.${number}.displayName` | `projectJob.codingAgentSessionId` | `projectJob.failureReason` | `projectJob.creditsExempt` | `projectJob.creditsCostUsd` | `projectJob.suggestions` | `projectJob.suggestions.${number}.label` | `projectJob.suggestions.${number}.prompt`, 3>>;
+}
+/** @internal */
+declare function getLatestProjectJob$1(httpClient: HttpClient): GetLatestProjectJobSignature;
+interface GetLatestProjectJobSignature {
+    /**
+     * Gets the latest job for a project, for the project owner to poll build progress.
+     * @param - ID of the project to get the latest job for.
+     */
+    (projectId: string): Promise<NonNullablePaths<GetLatestProjectJobResponse, `projectJob.projectId` | `projectJob.jobType` | `projectJob.platform` | `projectJob.jobStatus` | `projectJob.prompt` | `projectJob.attachments` | `projectJob.attachments.${number}.type` | `projectJob.attachments.${number}.url` | `projectJob.attachments.${number}.displayName` | `projectJob.codingAgentSessionId` | `projectJob.failureReason` | `projectJob.creditsExempt` | `projectJob.creditsCostUsd` | `projectJob.suggestions` | `projectJob.suggestions.${number}.label` | `projectJob.suggestions.${number}.prompt`, 3>>;
+}
+/** @internal */
+declare function createSuggestionsJob$1(httpClient: HttpClient): CreateSuggestionsJobSignature;
+interface CreateSuggestionsJobSignature {
+    /**
+     * Queues suggestions for the current project conversation.
+     * @param - ID of the project receiving the suggestions job.
+     */
+    (projectId: string, options?: NonNullablePaths<CreateSuggestionsJobOptions, `conversationId`, 0>): Promise<NonNullablePaths<CreateSuggestionsJobResponse, `projectJob.projectId` | `projectJob.jobType` | `projectJob.platform` | `projectJob.jobStatus` | `projectJob.prompt` | `projectJob.attachments` | `projectJob.attachments.${number}.type` | `projectJob.attachments.${number}.url` | `projectJob.attachments.${number}.displayName` | `projectJob.codingAgentSessionId` | `projectJob.failureReason` | `projectJob.creditsExempt` | `projectJob.creditsCostUsd` | `projectJob.suggestions` | `projectJob.suggestions.${number}.label` | `projectJob.suggestions.${number}.prompt`, 3>>;
+}
+/** @internal */
+declare function openProjectJobActivity$1(httpClient: HttpClient): OpenProjectJobActivitySignature;
+interface OpenProjectJobActivitySignature {
+    /**
+     * Registers the activity stream for an active job owned by the caller.
+     * @param - ID of the project job.
+     * @param - ID of the activity stream.
+     */
+    (projectJobId: string, streamId: string): Promise<NonNullablePaths<OpenProjectJobActivityResponse, `jobId` | `streamId` | `latestSequence`, 0>>;
+}
+/** @internal */
+declare function reportProjectJobActivity$1(httpClient: HttpClient): ReportProjectJobActivitySignature;
+interface ReportProjectJobActivitySignature {
+    /**
+     * Persists an idempotent semantic activity batch for the registered stream.
+     * @param - ID of the project job.
+     * @param - Semantic activity batch to persist. Its Base64-encoded protobuf must fit within 16,000 characters.
+     */
+    (projectJobId: string, batch: ActivityBatch): Promise<NonNullablePaths<ReportProjectJobActivityResponse, `jobId` | `streamId` | `acceptedSequence` | `latestSequence`, 0>>;
+}
+/** @internal */
+declare function queryProjectJobActivity$1(httpClient: HttpClient): QueryProjectJobActivitySignature;
+interface QueryProjectJobActivitySignature {
+    /**
+     * Replays persisted activity for the current owner, using the latest stream when omitted.
+     * @param - ID of the project job.
+     */
+    (projectJobId: string, options?: QueryProjectJobActivityOptions): Promise<NonNullablePaths<QueryProjectJobActivityResponse, `batches` | `batches.${number}.jobId` | `batches.${number}.streamId` | `batches.${number}.batchSequence` | `batches.${number}.schemaVersion` | `batches.${number}.reportingProfileVersion` | `batches.${number}.workflow` | `latestSequence` | `nextSequence` | `historyExpired` | `jobId` | `streamId` | `notificationAppDefId`, 2>>;
+}
+
+declare function customQueryProjectJobs(httpClient: HttpClient): {
+    (query: ProjectJobQuery, options: QueryProjectJobsOptions): ReturnType<typeof typedQueryProjectJobs>;
+    (options: QueryProjectJobsOptions): ProjectJobsQueryBuilder;
+};
+/** @internal */
+declare const createProjectJob: MaybeContext<BuildRESTFunction<typeof createProjectJob$1> & typeof createProjectJob$1>;
+/** @internal */
+declare const getProjectJob: MaybeContext<BuildRESTFunction<typeof getProjectJob$1> & typeof getProjectJob$1>;
+/** @internal */
+declare const getCurrentProjectJob: MaybeContext<BuildRESTFunction<typeof getCurrentProjectJob$1> & typeof getCurrentProjectJob$1>;
+/** @internal */
+declare const updateProjectJobStatus: MaybeContext<BuildRESTFunction<typeof updateProjectJobStatus$1> & typeof updateProjectJobStatus$1>;
+/** @internal */
+declare const clearProjectJobAssistantResponse: MaybeContext<BuildRESTFunction<typeof clearProjectJobAssistantResponse$1> & typeof clearProjectJobAssistantResponse$1>;
+/** @internal */
+declare const cancelProjectJob: MaybeContext<BuildRESTFunction<typeof cancelProjectJob$1> & typeof cancelProjectJob$1>;
+/** @internal */
+declare const getLatestProjectJob: MaybeContext<BuildRESTFunction<typeof getLatestProjectJob$1> & typeof getLatestProjectJob$1>;
+/** @internal */
+declare const createSuggestionsJob: MaybeContext<BuildRESTFunction<typeof createSuggestionsJob$1> & typeof createSuggestionsJob$1>;
+/** @internal */
+declare const openProjectJobActivity: MaybeContext<BuildRESTFunction<typeof openProjectJobActivity$1> & typeof openProjectJobActivity$1>;
+/** @internal */
+declare const reportProjectJobActivity: MaybeContext<BuildRESTFunction<typeof reportProjectJobActivity$1> & typeof reportProjectJobActivity$1>;
+/** @internal */
+declare const queryProjectJobActivity: MaybeContext<BuildRESTFunction<typeof queryProjectJobActivity$1> & typeof queryProjectJobActivity$1>;
+declare const queryProjectJobs: MaybeContext<BuildRESTFunction<typeof customQueryProjectJobs> & typeof customQueryProjectJobs>;
+
+export { ActivityBatch, CancelProjectJobResponse, ClearProjectJobAssistantResponseResponse, CreateSuggestionsJobOptions, CreateSuggestionsJobResponse, GetCurrentProjectJobResponse, GetLatestProjectJobResponse, JobStatusWithLiterals, OpenProjectJobActivityResponse, ProjectJob, ProjectJobQuery, ProjectJobsQueryBuilder, QueryProjectJobActivityOptions, QueryProjectJobActivityResponse, QueryProjectJobsOptions, ReportProjectJobActivityResponse, UpdateProjectJobStatusOptions, UpdateProjectJobStatusResponse, cancelProjectJob, clearProjectJobAssistantResponse, createProjectJob, createSuggestionsJob, getCurrentProjectJob, getLatestProjectJob, getProjectJob, openProjectJobActivity, queryProjectJobActivity, queryProjectJobs, reportProjectJobActivity, updateProjectJobStatus };