@breign/client 1.0.165 → 1.0.166

package/dist/apis/TicketsApi.d.ts

@@ -0,0 +1,288 @@
+/**
+ * brain-client
+ * Api ands models for brain-app and brain-app
+ *
+ * The version of the OpenAPI document: 0.0.0-SNAPSHOT
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { AcceptTicketProposalRequestUio, ConversationTicketProposalUio, CreateTicketArtifactRequestUio, CreateTicketArtifactResponseUio, CreateTicketEventRequestUio, CreateTicketRequestUio, MemberTypeUio, SetTicketAssigneesRequestUio, TicketArtifactDownloadUrlUio, TicketArtifactUio, TicketBoardUio, TicketEventUio, TicketReviewRequestUio, TicketStatusUio, TicketUio, UpdateTicketRequestUio } from '../models/index';
+export interface AcceptTicketProposalRequest {
+    proposalId: string;
+    acceptTicketProposalRequestUio: AcceptTicketProposalRequestUio;
+}
+export interface CancelTicketProposalRequest {
+    proposalId: string;
+}
+export interface CreateTicketRequest {
+    projectId: string;
+    createTicketRequestUio: CreateTicketRequestUio;
+}
+export interface CreateTicketArtifactRequest {
+    ticketId: string;
+    createTicketArtifactRequestUio: CreateTicketArtifactRequestUio;
+}
+export interface CreateTicketCommentRequest {
+    ticketId: string;
+    createTicketEventRequestUio: CreateTicketEventRequestUio;
+}
+export interface DeleteTicketArtifactRequest {
+    ticketId: string;
+    artifactId: string;
+}
+export interface GetProjectBoardRequest {
+    projectId: string;
+    doneLimit?: number;
+}
+export interface GetTicketRequest {
+    ticketId: string;
+}
+export interface GetTicketArtifactDownloadUrlRequest {
+    ticketId: string;
+    artifactId: string;
+}
+export interface GetTicketByKeyRequest {
+    organizationId: string;
+    ticketKey: string;
+}
+export interface GiveTicketGoAheadRequest {
+    ticketId: string;
+    assigneeType: MemberTypeUio;
+    assigneeId: string;
+}
+export interface ListProjectTicketsRequest {
+    projectId: string;
+    status?: Array<TicketStatusUio>;
+    mine?: boolean;
+    attention?: boolean;
+    agentsWorking?: boolean;
+    search?: string;
+    page?: number;
+    limit?: number;
+}
+export interface ListTicketArtifactsRequest {
+    ticketId: string;
+}
+export interface ListTicketEventsRequest {
+    ticketId: string;
+    page?: number;
+    limit?: number;
+}
+export interface MarkTicketArtifactUploadedRequest {
+    ticketId: string;
+    artifactId: string;
+}
+export interface RejectTicketProposalRequest {
+    proposalId: string;
+}
+export interface ReviewTicketRequest {
+    ticketId: string;
+    ticketReviewRequestUio: TicketReviewRequestUio;
+}
+export interface SetTicketAssigneesRequest {
+    ticketId: string;
+    setTicketAssigneesRequestUio: SetTicketAssigneesRequestUio;
+}
+export interface UpdateTicketRequest {
+    ticketId: string;
+    updateTicketRequestUio: UpdateTicketRequestUio;
+}
+/**
+ *
+ */
+export declare class TicketsApi extends runtime.BaseAPI {
+    /**
+     * Crée le ticket proposé par l\'agent, avec les corrections éventuelles. projectId est obligatoire si l\'agent n\'en a pas proposé.
+     * Accept a ticket proposal
+     */
+    acceptTicketProposalRaw(requestParameters: AcceptTicketProposalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TicketUio>>;
+    /**
+     * Crée le ticket proposé par l\'agent, avec les corrections éventuelles. projectId est obligatoire si l\'agent n\'en a pas proposé.
+     * Accept a ticket proposal
+     */
+    acceptTicketProposal(proposalId: string, acceptTicketProposalRequestUio: AcceptTicketProposalRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TicketUio>;
+    /**
+     * Annule un ticket créé sans confirmation : le ticket est supprimé tant que personne n\'y a travaillé.
+     * Cancel a ticket created directly by an agent
+     */
+    cancelTicketProposalRaw(requestParameters: CancelTicketProposalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationTicketProposalUio>>;
+    /**
+     * Annule un ticket créé sans confirmation : le ticket est supprimé tant que personne n\'y a travaillé.
+     * Cancel a ticket created directly by an agent
+     */
+    cancelTicketProposal(proposalId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationTicketProposalUio>;
+    /**
+     * Crée un ticket dans le projet ; son numéro suit la séquence du projet.
+     * Create a ticket
+     */
+    createTicketRaw(requestParameters: CreateTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TicketUio>>;
+    /**
+     * Crée un ticket dans le projet ; son numéro suit la séquence du projet.
+     * Create a ticket
+     */
+    createTicket(projectId: string, createTicketRequestUio: CreateTicketRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TicketUio>;
+    /**
+     * Déclare un fichier et renvoie l\'URL présignée où le téléverser.
+     * Attach a file to a ticket
+     */
+    createTicketArtifactRaw(requestParameters: CreateTicketArtifactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateTicketArtifactResponseUio>>;
+    /**
+     * Déclare un fichier et renvoie l\'URL présignée où le téléverser.
+     * Attach a file to a ticket
+     */
+    createTicketArtifact(ticketId: string, createTicketArtifactRequestUio: CreateTicketArtifactRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateTicketArtifactResponseUio>;
+    /**
+     * Ajoute un commentaire ; chaque @mention crée un élément dans l\'onglet Mentions du destinataire.
+     * Comment on a ticket
+     */
+    createTicketCommentRaw(requestParameters: CreateTicketCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TicketEventUio>>;
+    /**
+     * Ajoute un commentaire ; chaque @mention crée un élément dans l\'onglet Mentions du destinataire.
+     * Comment on a ticket
+     */
+    createTicketComment(ticketId: string, createTicketEventRequestUio: CreateTicketEventRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TicketEventUio>;
+    /**
+     * Retire l\'artefact et supprime le fichier téléversé.
+     * Remove an artifact from a ticket
+     */
+    deleteTicketArtifactRaw(requestParameters: DeleteTicketArtifactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Retire l\'artefact et supprime le fichier téléversé.
+     * Remove an artifact from a ticket
+     */
+    deleteTicketArtifact(ticketId: string, artifactId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Tickets par colonne. Les colonnes ouvertes sont complètes ; done ne contient que les tickets terminés les plus récents, son total compte tous les terminés.
+     * Get the board of a project
+     */
+    getProjectBoardRaw(requestParameters: GetProjectBoardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TicketBoardUio>>;
+    /**
+     * Tickets par colonne. Les colonnes ouvertes sont complètes ; done ne contient que les tickets terminés les plus récents, son total compte tous les terminés.
+     * Get the board of a project
+     */
+    getProjectBoard(projectId: string, doneLimit?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TicketBoardUio>;
+    /**
+     * Ticket avec ses assignés et leurs états.
+     * Get a ticket
+     */
+    getTicketRaw(requestParameters: GetTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TicketUio>>;
+    /**
+     * Ticket avec ses assignés et leurs états.
+     * Get a ticket
+     */
+    getTicket(ticketId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TicketUio>;
+    /**
+     * URL présignée de téléchargement, valable quelques minutes.
+     * Get a download URL for an artifact
+     */
+    getTicketArtifactDownloadUrlRaw(requestParameters: GetTicketArtifactDownloadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TicketArtifactDownloadUrlUio>>;
+    /**
+     * URL présignée de téléchargement, valable quelques minutes.
+     * Get a download URL for an artifact
+     */
+    getTicketArtifactDownloadUrl(ticketId: string, artifactId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TicketArtifactDownloadUrlUio>;
+    /**
+     * Ticket désigné par sa clé (BRN-142) dans une organisation.
+     * Get a ticket by its key
+     */
+    getTicketByKeyRaw(requestParameters: GetTicketByKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TicketUio>>;
+    /**
+     * Ticket désigné par sa clé (BRN-142) dans une organisation.
+     * Get a ticket by its key
+     */
+    getTicketByKey(organizationId: string, ticketKey: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TicketUio>;
+    /**
+     * Feu vert à un assigné en attente (held) : il passe à assigned et peut commencer.
+     * Give the go-ahead to an assignee
+     */
+    giveTicketGoAheadRaw(requestParameters: GiveTicketGoAheadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TicketUio>>;
+    /**
+     * Feu vert à un assigné en attente (held) : il passe à assigned et peut commencer.
+     * Give the go-ahead to an assignee
+     */
+    giveTicketGoAhead(ticketId: string, assigneeType: MemberTypeUio, assigneeId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TicketUio>;
+    /**
+     * Liste paginée. Filtrée sur done, elle est triée du plus récemment terminé au plus ancien ; sinon de la plus récente activité à la plus ancienne.
+     * List the tickets of a project
+     */
+    listProjectTicketsRaw(requestParameters: ListProjectTicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<TicketUio>>>;
+    /**
+     * Liste paginée. Filtrée sur done, elle est triée du plus récemment terminé au plus ancien ; sinon de la plus récente activité à la plus ancienne.
+     * List the tickets of a project
+     */
+    listProjectTickets(projectId: string, status?: Array<TicketStatusUio>, mine?: boolean, attention?: boolean, agentsWorking?: boolean, search?: string, page?: number, limit?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<TicketUio>>;
+    /**
+     * Artefacts joints au ticket, les plus récents d\'abord.
+     * List the artifacts of a ticket
+     */
+    listTicketArtifactsRaw(requestParameters: ListTicketArtifactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<TicketArtifactUio>>>;
+    /**
+     * Artefacts joints au ticket, les plus récents d\'abord.
+     * List the artifacts of a ticket
+     */
+    listTicketArtifacts(ticketId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<TicketArtifactUio>>;
+    /**
+     * Fil du ticket, du plus ancien au plus récent : commentaires, rapports, questions et événements.
+     * List the activity of a ticket
+     */
+    listTicketEventsRaw(requestParameters: ListTicketEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<TicketEventUio>>>;
+    /**
+     * Fil du ticket, du plus ancien au plus récent : commentaires, rapports, questions et événements.
+     * List the activity of a ticket
+     */
+    listTicketEvents(ticketId: string, page?: number, limit?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<TicketEventUio>>;
+    /**
+     * Confirme le téléversement : l\'artefact passe à ready.
+     * Mark an artifact as uploaded
+     */
+    markTicketArtifactUploadedRaw(requestParameters: MarkTicketArtifactUploadedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TicketArtifactUio>>;
+    /**
+     * Confirme le téléversement : l\'artefact passe à ready.
+     * Mark an artifact as uploaded
+     */
+    markTicketArtifactUploaded(ticketId: string, artifactId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TicketArtifactUio>;
+    /**
+     * Écarte la proposition ; aucun ticket n\'est créé.
+     * Reject a ticket proposal
+     */
+    rejectTicketProposalRaw(requestParameters: RejectTicketProposalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationTicketProposalUio>>;
+    /**
+     * Écarte la proposition ; aucun ticket n\'est créé.
+     * Reject a ticket proposal
+     */
+    rejectTicketProposal(proposalId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationTicketProposalUio>;
+    /**
+     * Décision du relecteur : approve passe le ticket à done ; changes le renvoie à doing avec le commentaire.
+     * Review a ticket
+     */
+    reviewTicketRaw(requestParameters: ReviewTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TicketUio>>;
+    /**
+     * Décision du relecteur : approve passe le ticket à done ; changes le renvoie à doing avec le commentaire.
+     * Review a ticket
+     */
+    reviewTicket(ticketId: string, ticketReviewRequestUio: TicketReviewRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TicketUio>;
+    /**
+     * Remplace les assignés. Les nouveaux agents démarrent selon startMode (réglage du projet par défaut) ; en hold, un feu vert est demandé.
+     * Replace the assignees of a ticket
+     */
+    setTicketAssigneesRaw(requestParameters: SetTicketAssigneesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TicketUio>>;
+    /**
+     * Remplace les assignés. Les nouveaux agents démarrent selon startMode (réglage du projet par défaut) ; en hold, un feu vert est demandé.
+     * Replace the assignees of a ticket
+     */
+    setTicketAssignees(ticketId: string, setTicketAssigneesRequestUio: SetTicketAssigneesRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TicketUio>;
+    /**
+     * Mise à jour partielle. Passer à done alors qu\'un relecteur est défini et n\'a pas approuvé est refusé (409).
+     * Update a ticket
+     */
+    updateTicketRaw(requestParameters: UpdateTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TicketUio>>;
+    /**
+     * Mise à jour partielle. Passer à done alors qu\'un relecteur est défini et n\'a pas approuvé est refusé (409).
+     * Update a ticket
+     */
+    updateTicket(ticketId: string, updateTicketRequestUio: UpdateTicketRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TicketUio>;
+}