@dazl/internal-api-client 1.10.0 → 1.11.0

package/src/types.gen.ts

@@ -113,6 +113,44 @@ export type OwnerDazlId = {
     ownerDazlId: string;
 };
 
+export type UserMention = {
+    dazlUserId: string;
+};
+
+export type CommentResolved = {
+    dazlUserId: string;
+    resolvedAt: string;
+};
+
+export type CommentContext = {
+    type: 'stage';
+    page: string;
+    selection?: string;
+};
+
+export type InternalCreateCommentInput = {
+    content: string;
+    authorDazlUserId: string;
+    mentions?: Array<UserMention>;
+    context?: CommentContext;
+};
+
+export type InternalEditCommentInput = {
+    content: string;
+    mentions?: Array<UserMention>;
+};
+
+export type InternalCreateReplyInput = {
+    content: string;
+    mentions?: Array<UserMention>;
+    authorDazlUserId: string;
+};
+
+export type InternalEditReplyInput = {
+    content: string;
+    mentions?: Array<UserMention>;
+};
+
 export type TemplateRaw = {
     id: string;
     name: string;
@@ -2606,6 +2644,662 @@ export type DeleteProjectInvitationResponses = {
 
 export type DeleteProjectInvitationResponse = DeleteProjectInvitationResponses[keyof DeleteProjectInvitationResponses];
 
+export type InternalListProjectCommentsData = {
+    body?: never;
+    path: {
+        projectId: string;
+    };
+    query?: never;
+    url: '/project/{projectId}/comments';
+};
+
+export type InternalListProjectCommentsErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues?: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Not Found
+     */
+    404: ErrorResponse;
+    /**
+     * Conflict
+     */
+    409: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+    /**
+     * Service Unavailable
+     */
+    503: ErrorResponse;
+};
+
+export type InternalListProjectCommentsError = InternalListProjectCommentsErrors[keyof InternalListProjectCommentsErrors];
+
+export type InternalListProjectCommentsResponses = {
+    /**
+     * Returns the list of comments for the project
+     */
+    200: {
+        comments: Array<{
+            commentId: string;
+            author: {
+                dazlUserId: string;
+            };
+            content: string;
+            mentions: Array<UserMention>;
+            createdAt: string;
+            updatedAt: string;
+            lastActivityAt: string;
+            isEdited: boolean;
+            replies: Array<{
+                replyId: string;
+                author: {
+                    dazlUserId: string;
+                };
+                content: string;
+                mentions: Array<UserMention>;
+                createdAt: string;
+                updatedAt: string;
+            }>;
+            resolved?: CommentResolved;
+            context?: CommentContext;
+        }>;
+        /**
+         * Authors and mentions from loaded comments with id, email and picture to render avatars
+         */
+        participants: Array<{
+            userId: string;
+            email: string;
+            picture?: string;
+        }>;
+    };
+};
+
+export type InternalListProjectCommentsResponse = InternalListProjectCommentsResponses[keyof InternalListProjectCommentsResponses];
+
+export type InternalCreateCommentData = {
+    body: InternalCreateCommentInput;
+    path: {
+        projectId: string;
+    };
+    query?: never;
+    url: '/project/{projectId}/comments';
+};
+
+export type InternalCreateCommentErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues?: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Not Found
+     */
+    404: ErrorResponse;
+    /**
+     * Conflict
+     */
+    409: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+    /**
+     * Service Unavailable
+     */
+    503: ErrorResponse;
+};
+
+export type InternalCreateCommentError = InternalCreateCommentErrors[keyof InternalCreateCommentErrors];
+
+export type InternalCreateCommentResponses = {
+    /**
+     * Returns the created comment
+     */
+    200: {
+        comment: {
+            commentId: string;
+            author: {
+                dazlUserId: string;
+            };
+            content: string;
+            mentions: Array<UserMention>;
+            createdAt: string;
+            updatedAt: string;
+            lastActivityAt: string;
+            isEdited: boolean;
+            replies: Array<{
+                replyId: string;
+                author: {
+                    dazlUserId: string;
+                };
+                content: string;
+                mentions: Array<UserMention>;
+                createdAt: string;
+                updatedAt: string;
+            }>;
+            resolved?: CommentResolved;
+            context?: CommentContext;
+        };
+    };
+};
+
+export type InternalCreateCommentResponse = InternalCreateCommentResponses[keyof InternalCreateCommentResponses];
+
+export type InternalDeleteCommentData = {
+    body?: never;
+    path: {
+        projectId: string;
+        commentId: string;
+    };
+    query?: never;
+    url: '/project/{projectId}/comments/{commentId}';
+};
+
+export type InternalDeleteCommentErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues?: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Not Found
+     */
+    404: ErrorResponse;
+    /**
+     * Conflict
+     */
+    409: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+    /**
+     * Service Unavailable
+     */
+    503: ErrorResponse;
+};
+
+export type InternalDeleteCommentError = InternalDeleteCommentErrors[keyof InternalDeleteCommentErrors];
+
+export type InternalDeleteCommentResponses = {
+    /**
+     * Acknowledges that the comment was deleted
+     */
+    200: {
+        success: true;
+    };
+};
+
+export type InternalDeleteCommentResponse = InternalDeleteCommentResponses[keyof InternalDeleteCommentResponses];
+
+export type InternalEditCommentData = {
+    body: InternalEditCommentInput;
+    path: {
+        projectId: string;
+        commentId: string;
+    };
+    query?: never;
+    url: '/project/{projectId}/comments/{commentId}';
+};
+
+export type InternalEditCommentErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues?: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Not Found
+     */
+    404: ErrorResponse;
+    /**
+     * Conflict
+     */
+    409: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+    /**
+     * Service Unavailable
+     */
+    503: ErrorResponse;
+};
+
+export type InternalEditCommentError = InternalEditCommentErrors[keyof InternalEditCommentErrors];
+
+export type InternalEditCommentResponses = {
+    /**
+     * Returns the updated comment
+     */
+    200: {
+        comment: {
+            commentId: string;
+            author: {
+                dazlUserId: string;
+            };
+            content: string;
+            mentions: Array<UserMention>;
+            createdAt: string;
+            updatedAt: string;
+            lastActivityAt: string;
+            isEdited: boolean;
+            replies: Array<{
+                replyId: string;
+                author: {
+                    dazlUserId: string;
+                };
+                content: string;
+                mentions: Array<UserMention>;
+                createdAt: string;
+                updatedAt: string;
+            }>;
+            resolved?: CommentResolved;
+            context?: CommentContext;
+        };
+    };
+};
+
+export type InternalEditCommentResponse = InternalEditCommentResponses[keyof InternalEditCommentResponses];
+
+export type InternalResolveCommentData = {
+    body?: never;
+    path: {
+        projectId: string;
+        commentId: string;
+    };
+    query: {
+        resolvedByDazlUserId: string;
+    };
+    url: '/project/{projectId}/comments/{commentId}/resolve';
+};
+
+export type InternalResolveCommentErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues?: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Not Found
+     */
+    404: ErrorResponse;
+    /**
+     * Conflict
+     */
+    409: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+    /**
+     * Service Unavailable
+     */
+    503: ErrorResponse;
+};
+
+export type InternalResolveCommentError = InternalResolveCommentErrors[keyof InternalResolveCommentErrors];
+
+export type InternalResolveCommentResponses = {
+    /**
+     * Returns the resolved comment
+     */
+    200: {
+        comment: {
+            commentId: string;
+            author: {
+                dazlUserId: string;
+            };
+            content: string;
+            mentions: Array<UserMention>;
+            createdAt: string;
+            updatedAt: string;
+            lastActivityAt: string;
+            isEdited: boolean;
+            replies: Array<{
+                replyId: string;
+                author: {
+                    dazlUserId: string;
+                };
+                content: string;
+                mentions: Array<UserMention>;
+                createdAt: string;
+                updatedAt: string;
+            }>;
+            resolved?: CommentResolved;
+            context?: CommentContext;
+        };
+    };
+};
+
+export type InternalResolveCommentResponse = InternalResolveCommentResponses[keyof InternalResolveCommentResponses];
+
+export type InternalReopenCommentData = {
+    body?: never;
+    path: {
+        projectId: string;
+        commentId: string;
+    };
+    query?: never;
+    url: '/project/{projectId}/comments/{commentId}/reopen';
+};
+
+export type InternalReopenCommentErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues?: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Not Found
+     */
+    404: ErrorResponse;
+    /**
+     * Conflict
+     */
+    409: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+    /**
+     * Service Unavailable
+     */
+    503: ErrorResponse;
+};
+
+export type InternalReopenCommentError = InternalReopenCommentErrors[keyof InternalReopenCommentErrors];
+
+export type InternalReopenCommentResponses = {
+    /**
+     * Returns the reopened comment
+     */
+    200: {
+        comment: {
+            commentId: string;
+            author: {
+                dazlUserId: string;
+            };
+            content: string;
+            mentions: Array<UserMention>;
+            createdAt: string;
+            updatedAt: string;
+            lastActivityAt: string;
+            isEdited: boolean;
+            replies: Array<{
+                replyId: string;
+                author: {
+                    dazlUserId: string;
+                };
+                content: string;
+                mentions: Array<UserMention>;
+                createdAt: string;
+                updatedAt: string;
+            }>;
+            resolved?: CommentResolved;
+            context?: CommentContext;
+        };
+    };
+};
+
+export type InternalReopenCommentResponse = InternalReopenCommentResponses[keyof InternalReopenCommentResponses];
+
+export type InternalCreateReplyData = {
+    body: InternalCreateReplyInput;
+    path: {
+        projectId: string;
+        commentId: string;
+    };
+    query?: never;
+    url: '/project/{projectId}/comments/{commentId}/replies';
+};
+
+export type InternalCreateReplyErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues?: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Not Found
+     */
+    404: ErrorResponse;
+    /**
+     * Conflict
+     */
+    409: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+    /**
+     * Service Unavailable
+     */
+    503: ErrorResponse;
+};
+
+export type InternalCreateReplyError = InternalCreateReplyErrors[keyof InternalCreateReplyErrors];
+
+export type InternalCreateReplyResponses = {
+    /**
+     * Returns the created reply
+     */
+    200: {
+        reply: {
+            replyId: string;
+            author: {
+                dazlUserId: string;
+            };
+            content: string;
+            mentions: Array<UserMention>;
+            createdAt: string;
+            updatedAt: string;
+        };
+    };
+};
+
+export type InternalCreateReplyResponse = InternalCreateReplyResponses[keyof InternalCreateReplyResponses];
+
+export type InternalDeleteReplyData = {
+    body?: never;
+    path: {
+        projectId: string;
+        commentId: string;
+        replyId: string;
+    };
+    query?: never;
+    url: '/project/{projectId}/comments/{commentId}/replies/{replyId}';
+};
+
+export type InternalDeleteReplyErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues?: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Not Found
+     */
+    404: ErrorResponse;
+    /**
+     * Conflict
+     */
+    409: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+    /**
+     * Service Unavailable
+     */
+    503: ErrorResponse;
+};
+
+export type InternalDeleteReplyError = InternalDeleteReplyErrors[keyof InternalDeleteReplyErrors];
+
+export type InternalDeleteReplyResponses = {
+    /**
+     * Acknowledges that the reply was deleted
+     */
+    200: {
+        success: true;
+    };
+};
+
+export type InternalDeleteReplyResponse = InternalDeleteReplyResponses[keyof InternalDeleteReplyResponses];
+
+export type InternalEditReplyData = {
+    body: InternalEditReplyInput;
+    path: {
+        projectId: string;
+        commentId: string;
+        replyId: string;
+    };
+    query?: never;
+    url: '/project/{projectId}/comments/{commentId}/replies/{replyId}';
+};
+
+export type InternalEditReplyErrors = {
+    /**
+     * Bad request - Invalid parameters or malformed JSON
+     */
+    400: {
+        message: string;
+        issues?: string;
+    };
+    /**
+     * Unauthorized
+     */
+    401: ErrorResponse;
+    /**
+     * Forbidden
+     */
+    403: ErrorResponse;
+    /**
+     * Not Found
+     */
+    404: ErrorResponse;
+    /**
+     * Conflict
+     */
+    409: ErrorResponse;
+    /**
+     * Internal server error
+     */
+    500: ErrorResponse;
+    /**
+     * Service Unavailable
+     */
+    503: ErrorResponse;
+};
+
+export type InternalEditReplyError = InternalEditReplyErrors[keyof InternalEditReplyErrors];
+
+export type InternalEditReplyResponses = {
+    /**
+     * Returns the updated reply
+     */
+    200: {
+        reply: {
+            replyId: string;
+            author: {
+                dazlUserId: string;
+            };
+            content: string;
+            mentions: Array<UserMention>;
+            createdAt: string;
+            updatedAt: string;
+        };
+    };
+};
+
+export type InternalEditReplyResponse = InternalEditReplyResponses[keyof InternalEditReplyResponses];
+
 export type GetPublicTemplatesData = {
     body?: never;
     path?: never;
@@ -3597,19 +4291,7 @@ export type ScrapePageContentResponses = {
             images?: {
                 [key: string]: unknown;
             } | null;
-            [key: string]: unknown | 'light' | 'dark' | null | string | null | {
-                [key: string]: unknown;
-            } | null | Array<{
-                [key: string]: unknown;
-            }> | null | {
-                [key: string]: unknown;
-            } | null | {
-                [key: string]: unknown;
-            } | null | {
-                [key: string]: unknown;
-            } | null | {
-                [key: string]: unknown;
-            } | null | undefined;
+            [key: string]: unknown;
         };
     };
 };