@createiq/backend 1.0.20 → 1.0.21

package/client/types.gen.ts

@@ -680,6 +680,8 @@ export type DocumentErrorResponseDto = {
     documentCauses?: Array<MajorChangeSummaryDto>;
 };
 
+export type AuditReportType = 'audit_log_report' | 'comments_log_report';
+
 export type UserForPickerDto = {
     role: string;
     profileColour: '#000000' | '#6750A4' | '#5C6B8A' | '#008569' | '#F5A623' | '#0172B1' | '#DC2773' | '#B3261E';
@@ -1950,7 +1952,7 @@ export type SignatureExistsDto_RequiredSignaturePageDto = {
     sigPageId: string;
 };
 
-export type EmailTemplate = 'userInvite' | 'accountInvite' | 'negotiationCreateAccountInvite' | 'negotiationOneLinkInvite' | 'registerSSOUser' | 'approversRemoved' | 'approversFixed' | 'userTaggedInComment' | 'userTaggedInApprovalComment' | 'forwardInvite' | 'forgottenPassword' | 'unregisteredUserForgottenPassword' | 'negotiationInvite' | 'notifyDraft' | 'supportAccessConfirmation' | 'negotiationInviteApproverOrAdmin' | 'negotiationInviteNamedWhereNoEntity' | 'negotiationInviteNamedWhereNoUser' | 'negotiationInviteEntityManagement' | 'negotiationStarted' | 'negotiationUpdate' | 'negotiationGroupInvite' | 'negotiationGroupCreateAccountInvite' | 'negotiationGroupInviteApproverOrAdmin' | 'negotiationGroupInviteNamedWhereNoEntity' | 'negotiationGroupInviteEntityManagement' | 'negotiationGroupInviteNamedWhereNoUser' | 'negotiationGroupUpdate' | 'negotiationGroupDissolved' | 'chaserEmail' | 'sSOExpiresSoon' | 'sSOExpiresImminently' | 'finalDocumentRejected' | 'finalDocumentApproved' | 'finalApprovalRequired' | 'contactSMForNewApprovalRequired' | 'electionApprovalRequired' | 'documentApprovalReminder' | 'electionApprovalReminder' | 'electionApprovalResponsesReceived' | 'confirmAgreedForm' | 'executionAgreed' | 'negotiationComplete' | 'revertToAmending' | 'executionCpPagesUploaded' | 'inviteExistingUserAdvisorAccount' | 'inviteExistingUserNonAdvisorAccount' | 'inviteNewUserAdvisorAccount' | 'inviteNewUserNonAdvisorAccount' | 'inviteNewAccount' | 'advisorRequestRejected' | 'advisorRequestAccepted' | 'notifyBreakingChange' | 'auxiliaryDocumentUploaded' | 'negotiationExtendedWorkflowStage1ConfirmTemplate' | 'noContent' | 'negotiationUnsubscribe' | 'negotiationReport' | 'notifyCounterpartyUnsubscribed' | 'dailyNotificationDigest' | 'existingApproverReplaced';
+export type EmailTemplate = 'userInvite' | 'accountInvite' | 'negotiationCreateAccountInvite' | 'negotiationOneLinkInvite' | 'registerSSOUser' | 'approversRemoved' | 'approversFixed' | 'userTaggedInComment' | 'userTaggedInApprovalComment' | 'forwardInvite' | 'forgottenPassword' | 'unregisteredUserForgottenPassword' | 'negotiationInvite' | 'notifyDraft' | 'supportAccessConfirmation' | 'negotiationInviteApproverOrAdmin' | 'negotiationInviteNamedWhereNoEntity' | 'negotiationInviteNamedWhereNoUser' | 'negotiationInviteEntityManagement' | 'negotiationStarted' | 'negotiationUpdate' | 'negotiationGroupInvite' | 'negotiationGroupCreateAccountInvite' | 'negotiationGroupInviteApproverOrAdmin' | 'negotiationGroupInviteNamedWhereNoEntity' | 'negotiationGroupInviteEntityManagement' | 'negotiationGroupInviteNamedWhereNoUser' | 'negotiationGroupUpdate' | 'negotiationGroupDissolved' | 'chaserEmail' | 'sSOExpiresSoon' | 'sSOExpiresImminently' | 'finalDocumentRejected' | 'finalDocumentApproved' | 'finalApprovalRequired' | 'contactSMForNewApprovalRequired' | 'electionApprovalRequired' | 'documentApprovalReminder' | 'electionApprovalReminder' | 'electionApprovalResponsesReceived' | 'confirmAgreedForm' | 'executionAgreed' | 'negotiationComplete' | 'revertToAmending' | 'executionCpPagesUploaded' | 'inviteExistingUserAdvisorAccount' | 'inviteExistingUserNonAdvisorAccount' | 'inviteNewUserAdvisorAccount' | 'inviteNewUserNonAdvisorAccount' | 'inviteNewAccount' | 'advisorRequestRejected' | 'advisorRequestAccepted' | 'notifyBreakingChange' | 'auxiliaryDocumentUploaded' | 'negotiationExtendedWorkflowStage1ConfirmTemplate' | 'noContent' | 'negotiationUnsubscribe' | 'negotiationReport' | 'auditReport' | 'notifyCounterpartyUnsubscribed' | 'dailyNotificationDigest' | 'existingApproverReplaced';
 
 export type PartyRelativeRef = 'our' | 'counterparty';
 
@@ -4338,25 +4340,23 @@ export type UpdateSelectedElections_Responses = {
 
 export type UpdateSelectedElections_Response = UpdateSelectedElections_Responses[keyof UpdateSelectedElections_Responses];
 
-export type AuditTrailForAccountAsExcel_Data = {
+export type GenerateAuditTrailForAccountAsExcel_Data = {
     body?: never;
     path?: never;
     query: {
         includeSubAccountEvents: boolean;
-        yearMonths: Array<string>;
+        yearMonths?: Array<string>;
     };
     url: '/api/v1/account/audit_trail/xlsx';
 };
 
-export type AuditTrailForAccountAsExcel_Responses = {
+export type GenerateAuditTrailForAccountAsExcel_Responses = {
     /**
-     * XLSX formatted data
+     * The report was generated and the email was sent
      */
-    200: Blob | File;
+    202: unknown;
 };
 
-export type AuditTrailForAccountAsExcel_Response = AuditTrailForAccountAsExcel_Responses[keyof AuditTrailForAccountAsExcel_Responses];
-
 export type PresetEditAnswers_Data = {
     body: PartyAnswersDto;
     path: {
@@ -4871,6 +4871,36 @@ export type NegotiationForkHistory_Responses = {
 
 export type NegotiationForkHistory_Response = NegotiationForkHistory_Responses[keyof NegotiationForkHistory_Responses];
 
+export type MoveEntity_Data = {
+    body: MoveEntityDto;
+    path: {
+        entityId: string;
+        subAccountId: string;
+    };
+    query?: never;
+    url: '/api/v1/subAccounts/{subAccountId}/entity/{entityId}/move';
+};
+
+export type MoveEntity_Errors = {
+    /**
+     * Entity could not be found on the Sub-Account
+     */
+    404: unknown;
+    /**
+     * Entity cannot be moved from and to the same Sub-Account
+     */
+    419: unknown;
+};
+
+export type MoveEntity_Responses = {
+    /**
+     * Entity successfully moved
+     */
+    200: RemovedUsersDto;
+};
+
+export type MoveEntity_Response = MoveEntity_Responses[keyof MoveEntity_Responses];
+
 export type ListEntities_Data = {
     body?: never;
     path?: never;
@@ -4964,10 +4994,147 @@ export type SetElectionApproval_Responses = {
 
 export type SetElectionApproval_Response = SetElectionApproval_Responses[keyof SetElectionApproval_Responses];
 
-export type DownloadDashboardReportAsExcel_Data = {
+export type DeleteApprovalComment_Data = {
+    body?: never;
+    path: {
+        subAccountId: string;
+        negotiationId: string;
+        approvalCommentId: string;
+    };
+    query?: never;
+    url: '/api/v1/subAccounts/{subAccountId}/negotiations/{negotiationId}/approvals/comment/{approvalCommentId}';
+};
+
+export type DeleteApprovalComment_Errors = {
+    /**
+     * Action not permitted (user does not have permission)
+     */
+    403: unknown;
+};
+
+export type DeleteApprovalComment_Responses = {
+    /**
+     * The deleted comment
+     */
+    200: unknown;
+};
+
+export type EditApprovalComment_Data = {
+    body: UpdateCommentDto;
+    path: {
+        subAccountId: string;
+        negotiationId: string;
+        approvalCommentId: string;
+    };
+    query?: never;
+    url: '/api/v1/subAccounts/{subAccountId}/negotiations/{negotiationId}/approvals/comment/{approvalCommentId}';
+};
+
+export type EditApprovalComment_Errors = {
+    /**
+     * Comment value is empty
+     */
+    403: unknown;
+};
+
+export type EditApprovalComment_Responses = {
+    /**
+     * The updated comment
+     */
+    200: ApprovalCommentDto;
+};
+
+export type EditApprovalComment_Response = EditApprovalComment_Responses[keyof EditApprovalComment_Responses];
+
+export type DeleteExternalAttachment_Data = {
+    body?: never;
+    path: {
+        subAccountId: string;
+        negotiationId: string;
+        fileName: string;
+    };
+    query?: never;
+    url: '/api/v1/subAccounts/{subAccountId}/negotiations/{negotiationId}/attachment/{fileName}';
+};
+
+export type DeleteExternalAttachment_Responses = {
+    /**
+     * The invite attachment was deleted successfully. Returns all invite attachments
+     */
+    200: AttachmentsExistsDto;
+};
+
+export type DeleteExternalAttachment_Response = DeleteExternalAttachment_Responses[keyof DeleteExternalAttachment_Responses];
+
+export type GetExternalAttachment_Data = {
+    body?: never;
+    path: {
+        subAccountId: string;
+        negotiationId: string;
+        fileName: string;
+    };
+    query?: never;
+    url: '/api/v1/subAccounts/{subAccountId}/negotiations/{negotiationId}/attachment/{fileName}';
+};
+
+export type GetExternalAttachment_Errors = {
+    /**
+     * Missing document
+     */
+    404: unknown;
+};
+
+export type GetExternalAttachment_Responses = {
+    /**
+     * The uploaded invite attachment
+     */
+    200: Blob | File;
+};
+
+export type GetExternalAttachment_Response = GetExternalAttachment_Responses[keyof GetExternalAttachment_Responses];
+
+export type ListPotentialNegotiationAdvisors_Data = {
     body?: never;
     path: {
         subAccountId: string;
+        negotiationId: string;
+    };
+    query?: never;
+    url: '/api/v1/advisor/subAccounts/{subAccountId}/negotiations/{negotiationId}/potentialAdvisors';
+};
+
+export type ListPotentialNegotiationAdvisors_Responses = {
+    /**
+     * A list of all advisors that can be given access to the specified negotiation
+     */
+    200: Array<PotentialAdvisorSummaryDto>;
+};
+
+export type ListPotentialNegotiationAdvisors_Response = ListPotentialNegotiationAdvisors_Responses[keyof ListPotentialNegotiationAdvisors_Responses];
+
+export type GetAccessibleNegotiation_Data = {
+    body?: never;
+    path: {
+        negotiationId: string;
+    };
+    query?: never;
+    url: '/api/v1/negotiations/{negotiationId}';
+};
+
+export type GetAccessibleNegotiation_Responses = {
+    /**
+     * A negotiation
+     */
+    200: Array<NegotiationSingleDto>;
+};
+
+export type GetAccessibleNegotiation_Response = GetAccessibleNegotiation_Responses[keyof GetAccessibleNegotiation_Responses];
+
+export type GenerateNegotiationsReport_Data = {
+    body?: never;
+    path: {
+        subAccountId: string;
+        fileType: string;
     };
     query: {
         /**
@@ -5139,184 +5306,16 @@ export type DownloadDashboardReportAsExcel_Data = {
          */
         missingApprovers?: boolean;
     };
-    url: '/api/v1/subAccounts/{subAccountId}/negotiations/xlsx';
+    url: '/api/v1/subAccounts/{subAccountId}/negotiations/report/{fileType}';
 };
 
-export type DownloadDashboardReportAsExcel_Responses = {
+export type GenerateNegotiationsReport_Responses = {
     /**
-     * A list of negotiations in XLSX formatted data
+     * The report was generated and the email was sent
      */
-    200: Blob | File;
+    202: unknown;
 };
 
-export type DownloadDashboardReportAsExcel_Response = DownloadDashboardReportAsExcel_Responses[keyof DownloadDashboardReportAsExcel_Responses];
-
-export type MoveEntity_Data = {
-    body: MoveEntityDto;
-    path: {
-        entityId: string;
-        subAccountId: string;
-    };
-    query?: never;
-    url: '/api/v1/subAccounts/{subAccountId}/entity/{entityId}/move';
-};
-
-export type MoveEntity_Errors = {
-    /**
-     * Entity could not be found on the Sub-Account
-     */
-    404: unknown;
-    /**
-     * Entity cannot be moved from and to the same Sub-Account
-     */
-    419: unknown;
-};
-
-export type MoveEntity_Responses = {
-    /**
-     * Entity successfully moved
-     */
-    200: RemovedUsersDto;
-};
-
-export type MoveEntity_Response = MoveEntity_Responses[keyof MoveEntity_Responses];
-
-export type DeleteApprovalComment_Data = {
-    body?: never;
-    path: {
-        subAccountId: string;
-        negotiationId: string;
-        approvalCommentId: string;
-    };
-    query?: never;
-    url: '/api/v1/subAccounts/{subAccountId}/negotiations/{negotiationId}/approvals/comment/{approvalCommentId}';
-};
-
-export type DeleteApprovalComment_Errors = {
-    /**
-     * Action not permitted (user does not have permission)
-     */
-    403: unknown;
-};
-
-export type DeleteApprovalComment_Responses = {
-    /**
-     * The deleted comment
-     */
-    200: unknown;
-};
-
-export type EditApprovalComment_Data = {
-    body: UpdateCommentDto;
-    path: {
-        subAccountId: string;
-        negotiationId: string;
-        approvalCommentId: string;
-    };
-    query?: never;
-    url: '/api/v1/subAccounts/{subAccountId}/negotiations/{negotiationId}/approvals/comment/{approvalCommentId}';
-};
-
-export type EditApprovalComment_Errors = {
-    /**
-     * Comment value is empty
-     */
-    403: unknown;
-};
-
-export type EditApprovalComment_Responses = {
-    /**
-     * The updated comment
-     */
-    200: ApprovalCommentDto;
-};
-
-export type EditApprovalComment_Response = EditApprovalComment_Responses[keyof EditApprovalComment_Responses];
-
-export type DeleteExternalAttachment_Data = {
-    body?: never;
-    path: {
-        subAccountId: string;
-        negotiationId: string;
-        fileName: string;
-    };
-    query?: never;
-    url: '/api/v1/subAccounts/{subAccountId}/negotiations/{negotiationId}/attachment/{fileName}';
-};
-
-export type DeleteExternalAttachment_Responses = {
-    /**
-     * The invite attachment was deleted successfully. Returns all invite attachments
-     */
-    200: AttachmentsExistsDto;
-};
-
-export type DeleteExternalAttachment_Response = DeleteExternalAttachment_Responses[keyof DeleteExternalAttachment_Responses];
-
-export type GetExternalAttachment_Data = {
-    body?: never;
-    path: {
-        subAccountId: string;
-        negotiationId: string;
-        fileName: string;
-    };
-    query?: never;
-    url: '/api/v1/subAccounts/{subAccountId}/negotiations/{negotiationId}/attachment/{fileName}';
-};
-
-export type GetExternalAttachment_Errors = {
-    /**
-     * Missing document
-     */
-    404: unknown;
-};
-
-export type GetExternalAttachment_Responses = {
-    /**
-     * The uploaded invite attachment
-     */
-    200: Blob | File;
-};
-
-export type GetExternalAttachment_Response = GetExternalAttachment_Responses[keyof GetExternalAttachment_Responses];
-
-export type ListPotentialNegotiationAdvisors_Data = {
-    body?: never;
-    path: {
-        subAccountId: string;
-        negotiationId: string;
-    };
-    query?: never;
-    url: '/api/v1/advisor/subAccounts/{subAccountId}/negotiations/{negotiationId}/potentialAdvisors';
-};
-
-export type ListPotentialNegotiationAdvisors_Responses = {
-    /**
-     * A list of all advisors that can be given access to the specified negotiation
-     */
-    200: Array<PotentialAdvisorSummaryDto>;
-};
-
-export type ListPotentialNegotiationAdvisors_Response = ListPotentialNegotiationAdvisors_Responses[keyof ListPotentialNegotiationAdvisors_Responses];
-
-export type GetAccessibleNegotiation_Data = {
-    body?: never;
-    path: {
-        negotiationId: string;
-    };
-    query?: never;
-    url: '/api/v1/negotiations/{negotiationId}';
-};
-
-export type GetAccessibleNegotiation_Responses = {
-    /**
-     * A negotiation
-     */
-    200: Array<NegotiationSingleDto>;
-};
-
-export type GetAccessibleNegotiation_Response = GetAccessibleNegotiation_Responses[keyof GetAccessibleNegotiation_Responses];
-
 export type ForkNegotiation_Data = {
     body?: never;
     path: {
@@ -6330,7 +6329,7 @@ export type GetDownloadExecutedNegotiationsAsExcel_Responses = {
 
 export type GetDownloadExecutedNegotiationsAsExcel_Response = GetDownloadExecutedNegotiationsAsExcel_Responses[keyof GetDownloadExecutedNegotiationsAsExcel_Responses];
 
-export type DownloadExecutedNegotiationsAsExcel_Data = {
+export type GenerateExecutedNegotiationsReportAsExcel_Data = {
     body?: ReportGenerationRequestDto;
     path: {
         subAccountId: string;
@@ -6339,22 +6338,20 @@ export type DownloadExecutedNegotiationsAsExcel_Data = {
     url: '/api/v1/subAccounts/{subAccountId}/executed_negotiations/xlsx';
 };
 
-export type DownloadExecutedNegotiationsAsExcel_Errors = {
+export type GenerateExecutedNegotiationsReportAsExcel_Errors = {
     /**
      * Negotiation not found
      */
     404: unknown;
 };
 
-export type DownloadExecutedNegotiationsAsExcel_Responses = {
+export type GenerateExecutedNegotiationsReportAsExcel_Responses = {
     /**
-     * XLSX formatted data
+     * The report was generated and the email was sent
      */
-    200: Blob | File;
+    202: unknown;
 };
 
-export type DownloadExecutedNegotiationsAsExcel_Response = DownloadExecutedNegotiationsAsExcel_Responses[keyof DownloadExecutedNegotiationsAsExcel_Responses];
-
 export type DeleteSignedSignaturePageForParty_Data = {
     body?: never;
     path: {
@@ -7956,26 +7953,25 @@ export type AssignUser_Responses = {
 
 export type AssignUser_Response = AssignUser_Responses[keyof AssignUser_Responses];
 
-export type GetAllNegotiationCommentsForSubAccount_Data = {
+export type GenerateCommentsReport_Data = {
     body?: never;
     path: {
         subAccountId: string;
     };
     query?: {
         yearMonths?: Array<string>;
+        timeZone?: string;
     };
     url: '/api/v1/subAccounts/{subAccountId}/comments/xlsx';
 };
 
-export type GetAllNegotiationCommentsForSubAccount_Responses = {
+export type GenerateCommentsReport_Responses = {
     /**
-     * XLSX formatted data
+     * The report was generated and the email was sent
      */
-    200: Blob | File;
+    202: unknown;
 };
 
-export type GetAllNegotiationCommentsForSubAccount_Response = GetAllNegotiationCommentsForSubAccount_Responses[keyof GetAllNegotiationCommentsForSubAccount_Responses];
-
 export type GetExtractionResults_Data = {
     body?: never;
     path: {
@@ -8721,26 +8717,24 @@ export type SetExternalAttachment_Responses = {
 
 export type SetExternalAttachment_Response = SetExternalAttachment_Responses[keyof SetExternalAttachment_Responses];
 
-export type AuditTrailForSubAccountAsExcel_Data = {
+export type GenerateAuditTrailForSubAccountAsExcel_Data = {
     body?: never;
     path: {
         subAccountId: string;
     };
-    query: {
-        yearMonths: Array<string>;
+    query?: {
+        yearMonths?: Array<string>;
     };
     url: '/api/v1/subAccounts/{subAccountId}/audit_trail/xlsx';
 };
 
-export type AuditTrailForSubAccountAsExcel_Responses = {
+export type GenerateAuditTrailForSubAccountAsExcel_Responses = {
     /**
-     * XLSX formatted data
+     * The report was generated and the email was sent
      */
-    200: Blob | File;
+    202: unknown;
 };
 
-export type AuditTrailForSubAccountAsExcel_Response = AuditTrailForSubAccountAsExcel_Responses[keyof AuditTrailForSubAccountAsExcel_Responses];
-
 export type ValidateDraftReceiverEmails_Data = {
     body: Array<DraftReceiverEmailsDto>;
     path: {
@@ -9903,7 +9897,7 @@ export type GetDownloadActiveNegotiationsReportAsExcel_Responses = {
 
 export type GetDownloadActiveNegotiationsReportAsExcel_Response = GetDownloadActiveNegotiationsReportAsExcel_Responses[keyof GetDownloadActiveNegotiationsReportAsExcel_Responses];
 
-export type DownloadActiveNegotiationsReportAsExcel_Data = {
+export type GenerateActiveNegotiationsReportAsExcel_Data = {
     body?: ReportGenerationRequestDto;
     path: {
         subAccountId: string;
@@ -9912,22 +9906,13 @@ export type DownloadActiveNegotiationsReportAsExcel_Data = {
     url: '/api/v1/subAccounts/{subAccountId}/negotiations/analytics/xlsx';
 };
 
-export type DownloadActiveNegotiationsReportAsExcel_Errors = {
+export type GenerateActiveNegotiationsReportAsExcel_Responses = {
     /**
-     * Negotiation not found
+     * The report was generated and the email was sent
      */
-    404: unknown;
+    202: unknown;
 };
 
-export type DownloadActiveNegotiationsReportAsExcel_Responses = {
-    /**
-     * XLSX formatted data
-     */
-    200: Blob | File;
-};
-
-export type DownloadActiveNegotiationsReportAsExcel_Response = DownloadActiveNegotiationsReportAsExcel_Responses[keyof DownloadActiveNegotiationsReportAsExcel_Responses];
-
 export type SetCounterparties_Data = {
     body: Array<CounterpartyWithReferenceIdDto>;
     path: {