@createiq/backend 1.0.24 → 1.0.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/client/sdk.gen.ts +112 -2
- package/client/types.gen.ts +194 -19
- package/dist/index.cjs +92 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +198 -20
- package/dist/index.d.ts +198 -20
- package/dist/index.js +86 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/swagger.json.sha256 +1 -1
package/client/sdk.gen.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
2
|
|
|
3
3
|
import { type Options as ClientOptions, type TDataShape, type Client, formDataBodySerializer } from '@hey-api/client-fetch';
|
|
4
|
-
import type { GetNegotiationDeltas_Data, GetAmendDefaults_Data, GetAmendDefaults_Response, NegotiationRenderTemplate_Data, NegotiationRenderTemplate_Response, CancelNegotiationsJobCount_Data, CancelNegotiationsJobCount_Response, AuditTrailForSubAccountAsJson_Data, AuditTrailForSubAccountAsJson_Response, GetDocumentSchema_Data, GetDocumentSchema_Response, AuditTrailForAccountAsJson_Data, AuditTrailForAccountAsJson_Response, SendBulkSetToCounterpartiesInitial_Data, SendBulkSetToCounterpartiesInitial_Response, GetWatchers_Data, GetWatchers_Response, AddWatchers_Data, AddWatchers_Response, GetUserStatistics_Data, GetUserStatistics_Response, RevertToAmending_Data, RevertToAmending_Response, SetReceiverEntity_Data, SetReceiverEntity_Response, MarkCommentEventsAsViewed_Data, PresetSetFinalApproval_Data, PresetSetFinalApproval_Response, AuthPing_Data, ListAllPresetsForSubAccountV1_Data, ListAllPresetsForSubAccountV1_Response, CreatePreset_Data, CreatePreset_Response, PresetGetMultipleNestedAnswers_Data, PresetGetMultipleNestedAnswers_Response, PresetSetMultipleNestedAnswers_Data, PresetSetMultipleNestedAnswers_Response, OverrideApproveFinalDocument_Data, DeleteEntity_Data, DeleteEntity_Response, GetSecurityContext_Data, GetSecurityContext_Response, UpdateSelectedElections_Data, UpdateSelectedElections_Response, GenerateAuditTrailForAccountAsExcel_Data, PresetEditAnswers_Data, PresetEditAnswers_Response, DeleteComment_Data, DeleteComment_Response, UpdateComment_Data, UpdateComment_Response, DeleteGeneralCoverNote_Data, DeleteGeneralCoverNote_Response, SetGeneralCoverNote_Data, SetGeneralCoverNote_Response, PublisherSummaries_Data, PublisherSummaries_Response, ValidateEntities_Data, ValidateEntities_Response, GrantAllNegotiationsAccess_Data, GrantAllNegotiationsAccess_Response, GetNegotiationESignStatus_Data, GetNegotiationESignStatus_Response, Unsubscribe_Data, OverrideRejectFinalDocument_Data, Version_Data, UpdateExtractionFeedback_Data, UpdateExtractionFeedback_Response, GetLatestDocumentSchema_Data, GetLatestDocumentSchema_Response, GetPreviousMajorVersionsNestedAnswerIds_Data, GetPreviousMajorVersionsNestedAnswerIds_Response, AddElectionRejection_Data, AddElectionRejection_Response, ListPresets_Data, ListPresets_Response, GetTimeline_Data, MarkEventsAsViewed_Data, NegotiationForkHistory_Data, NegotiationForkHistory_Response, MoveEntity_Data, MoveEntity_Response, ListEntities_Data, ListEntities_Response, AssignEntity_Data, AssignEntity_Response, SetFinalApproval_Data, SetFinalApproval_Response, SetElectionApproval_Data, SetElectionApproval_Response, DeleteApprovalComment_Data, EditApprovalComment_Data, EditApprovalComment_Response, DeleteExternalAttachment_Data, DeleteExternalAttachment_Response, GetExternalAttachment_Data, GetExternalAttachment_Response, ListPotentialNegotiationAdvisors_Data, ListPotentialNegotiationAdvisors_Response, GetAccessibleNegotiation_Data, GetAccessibleNegotiation_Response, GenerateNegotiationsReport_Data, ForkNegotiation_Data, ForkNegotiation_Response, AcceptAllCounterpartyPositions_Data, AcceptAllCounterpartyPositions_Response, NegotiationGetDocumentSchema_Data, NegotiationGetDocumentSchema_Response, UpdateGroupName_Data, ChangeSigningMode_Data, ChangeSigningMode_Response, SendToCounterparty_Data, SendToCounterparty_Response, VoidESignEnvelopeForNegotiation_Data, DeleteDocumentDraftingNote_Data, UpdateDocumentDraftingNote_Data, UpdateDocumentDraftingNote_Response, ShareNegotiation_Data, ShareNegotiation_Response, SetBulkSetAttachments_Data, SetBulkSetAttachments_Response, AddElectionApproval_Data, AddElectionApproval_Response, RejectFinalDocument_Data, GenerateAndMaybeSendEnvelope_Data, GetElectionAnswer_Data, GetElectionAnswer_Response, CreateAuditTrailJson_Data, CreateAuditTrailJson_Response, UpdateNegotiationsToMatch_Data, GetApprovalHistory_Data, GetApprovalHistory_Response, BulkSetsJobCount_Data, BulkSetsJobCount_Response, EditDefaultAnswers_Data, EditDefaultAnswers_Response, PresetSendForApproval_Data, PresetSendForApproval_Response, FixApprovalRules_Data, FixApprovalRules_Response, GetSubscribedPublishers_Data, GetSubscribedPublishers_Response, SendGroupToCounterparty_Data, SendGroupToCounterparty_Response, BreakingChanges_Data, BreakingChanges_Response, GetOtherPartyAnswers_Data, GetOtherPartyAnswers_Response, OverrideElectionRejection_Data, OverrideElectionRejection_Response, OverrideElectionApproval_Data, OverrideElectionApproval_Response, GetAllVersions_Data, GetAllVersions_Response, ListPotentialPresetAdvisors_Data, ListPotentialPresetAdvisors_Response, GetAsCdm_Data, GetAsCdm_Response, GetApprovalRound_Data, GetApprovalRound_Response, GetPreviousActiveUsers_Data, GetPreviousActiveUsers_Response, RevokePresetsAccess_Data, RevokePresetsAccess_Response, GrantPresetsAccess_Data, GrantPresetsAccess_Response, NotifyOfDraft_Data, RemoveWatchers_Data, RemoveWatchers_Response, GetNegotiation_Data, GetNegotiation_Response, UpdateMetadata_Data, UpdateMetadata_Response, GetDownloadExecutedNegotiationsAsExcel_Data, GetDownloadExecutedNegotiationsAsExcel_Response, GenerateExecutedNegotiationsReportAsExcel_Data, DeleteSignedSignaturePageForParty_Data, SetSignedSignaturePageForParty_Data, SetSignedSignaturePageForParty_Response, SuggestGroupName_Data, SuggestGroupName_Response, MarkActivityEventsAsViewed_Data, CancelExtraction_Data, CancelExtraction_Response, EditAnswers_Data, EditAnswers_Response, GetComments_Data, ContactForNewApprover_Data, GetDraftingNotesDocument_Data, GetDraftingNotesDocument_Response, AcceptAllPositionsFromFork_Data, AcceptAllPositionsFromFork_Response, AcceptAllPresetPositions_Data, AcceptAllPresetPositions_Response, SendChaserEmail_Data, CreateSigningPack_Data, CreateSigningPack_Response, GetGroupNames_Data, GetGroupNames_Response, CreateGroup_Data, CreateGroup_Response, GetNegotiationFilesSummary_Data, GetNegotiationFilesSummary_Response, GetUsers_Data, GetUsers_Response, GetSettings_Data, GetSettings_Response, Confirm_Data, Confirm_Response, SendDocumentApprovalReminder_Data, GetStatistics_Data, GetStatistics_Response, PresetSwapParties_Data, PresetSwapParties_Response, ApproveFinalDocument_Data, ResetUserAnswers_Data, ResetUserAnswers_Response, GetMajorVersions_Data, GetMajorVersions_Response, UpdateUserAnswers_Data, UpdateUserAnswers_Response, DeleteDocumentElectionDraftingNote_Data, UpdateDocumentElectionDraftingNote_Data, UpdateDocumentElectionDraftingNote_Response, AssignToMe_Data, AssignToMe_Response, UpdateGroupMembers_Data, GetSignedSignaturePagePdf_Data, GetSignedSignaturePagePdf_Response, PresetGetDocumentSchema_Data, PresetGetDocumentSchema_Response, ListSubAccounts_Data, DocumentsFilter_Data, DocumentsFilter_Response, MarkAsOffline_Data, MarkAsOffline_Response, CheckSignedSignaturePagePdf_Data, CheckSignedSignaturePagePdf_Response, GetAnnotatedOfflineNegotiatedDocument_Data, GetAnnotatedOfflineNegotiatedDocument_Response, DeleteAuxiliaryDocument_Data, DeleteAuxiliaryDocument_Response, GetAuxiliaryDocument_Data, GetAuxiliaryDocument_Response, SetAuxiliaryDocument_Data, SetAuxiliaryDocument_Response, DownloadPreExecutionCounterpartyNegotiation_Data, DownloadPreExecutionCounterpartyNegotiation_Response, Cancel_Data, Cancel_Response, RevokeNegotiationsAccess_Data, RevokeNegotiationsAccess_Response, GrantNegotiationsAccess_Data, GrantNegotiationsAccess_Response, ListDocuments_Data, ListDocuments_Response, GetPartyAnswers_Data, GetPartyAnswers_Response, DeletePreset_Data, GetPreset_Data, GetPreset_Response, CreatePresetAuditTrailJson_Data, CreatePresetAuditTrailJson_Response, GetPotentialUsers_Data, GetPotentialUsers_Response, GetNegotiationsGroup_Data, GetNegotiationsGroup_Response, ConsentCodeCallback_Data, GetOfflineNegotiatedDocumentAnnotations_Data, GetOfflineNegotiatedDocumentAnnotations_Response, AcceptAllCustodianTemplatePositions_Data, AcceptAllCustodianTemplatePositions_Response, AccountSummary_Data, AccountSummary_Response, GetApprovalComments_Data, GetApprovalComments_Response, ListAdvisorsForWorkspace_Data, ListAdvisorsForWorkspace_Response, CheckOfflineNegotiatedDocument_Data, CheckOfflineNegotiatedDocument_Response, DownloadPreset_Data, DownloadPreset_Response, AssignUser_Data, AssignUser_Response, GenerateCommentsReport_Data, GetExtractionResults_Data, GetExtractionResults_Response, ApplyExtractedAnswers_Data, ApplyExtractedAnswers_Response, GetOriginalAnswersForForkNegotiation_Data, GetOriginalAnswersForForkNegotiation_Response, MarkAsFinal_Data, MarkAsFinal_Response, GetPreviousMajorVersionsNestedAnswerElections_Data, GetPreviousMajorVersionsNestedAnswerElections_Response, ListNegotiations_Data, ListNegotiations_Response, CreateNegotiation_Data, CreateNegotiation_Response, PresetGetNestedAnswers_Data, PresetGetNestedAnswers_Response, PresetSetNestedAnswers_Data, PresetSetNestedAnswers_Response, CreatePresetAuditTrailXlsx_Data, CreatePresetAuditTrailXlsx_Response, ClonePreset_Data, ClonePreset_Response, ObtainConsent_Data, CheckAuxiliaryDocument_Data, CheckAuxiliaryDocument_Response, ListDocumentsWithPagination_Data, ListDocumentsWithPagination_Response, EmailPreferences_Data, EmailPreferences_Response, PatchEmailPreferences_Data, ConfirmExecutionVersion_Data, ConfirmExecutionVersion_Response, ListAllPresetsForSubAccountV2_Data, ListAllPresetsForSubAccountV2_Response, ListExternalAttachments_Data, ListExternalAttachments_Response, SetExternalAttachments_Data, SetExternalAttachments_Response, SetExternalAttachment_Data, SetExternalAttachment_Response, GenerateAuditTrailForSubAccountAsExcel_Data, ValidateDraftReceiverEmails_Data, ValidateDraftReceiverEmails_Response, DownloadPostExecutionPack_Data, DownloadPostExecutionPack_Response, MarkApprovalCommentsAsViewed_Data, AcceptCounterpartyPosition_Data, AcceptCounterpartyPosition_Response, CancelNegotiations_Data, CancelNegotiations_Response, GetNegotiationDraftingNotes_Data, GetNegotiationDraftingNotes_Response, AuditTrailFilters_Data, AuditTrailFilters_Response, GetCommentSummary_Data, DeleteExecutionAttachment_Data, DeleteExecutionAttachment_Response, GetExecutionAttachment_Data, GetExecutionAttachment_Response, GetUsersForPicker_Data, GetUsersForPicker_Response, SyncNewApprover_Data, GetMultipleNestedAnswers_Data, GetMultipleNestedAnswers_Response, SetMultipleNestedAnswers_Data, SetMultipleNestedAnswers_Response, GetDocument_Data, GetDocument_Response, ListBulkSets_Data, CreateBulkSet_Data, CreateBulkSet_Response, AddApprovalComment_Data, AddApprovalComment_Response, ScheduleExtraction_Data, ScheduleExtraction_Response, NegotiationsFilter_Data, NegotiationsFilter_Response, CreateAuditTrailXlsx_Data, CreateAuditTrailXlsx_Response, SetPreset_Data, SetPreset_Response, CheckForBrokenApprovers_Data, CheckForBrokenApprovers_Response, DeleteBulkSetAttachment_Data, DeleteBulkSetAttachment_Response, GetBulkSetAttachment_Data, GetBulkSetAttachment_Response, UsersWithNegotiationAccess_Data, UsersWithNegotiationAccess_Response, GetStatisticsOverview_Data, GetStatisticsOverview_Response, GetSubAccount_Data, UpdateSubAccount_Data, SetOwnerEntity_Data, SetOwnerEntity_Response, NegotiationSendForApproval_Data, NegotiationSendForApproval_Response, SearchEntity_Data, SearchEntity_Response, ListDocumentsVersionsSummary_Data, ListDocumentsVersionsSummary_Response, Retract_Data, Retract_Response, AcceptAllPositionsFromPreviousVersion_Data, AcceptAllPositionsFromPreviousVersion_Response, RenameExecutionAttachment_Data, RenameExecutionAttachment_Response, GetNestedAnswers_Data, GetNestedAnswers_Response, SetNestedAnswers_Data, SetNestedAnswers_Response, GetBulkSet_Data, GetBulkSet_Response, ListExecutionAttachments_Data, ListExecutionAttachments_Response, SetExecutionAttachments_Data, SetExecutionAttachments_Response, SetExecutionAttachment_Data, SetExecutionAttachment_Response, CheckSignedExecutedVersion_Data, CheckSignedExecutedVersion_Response, GetDownloadActiveNegotiationsReportAsExcel_Data, GetDownloadActiveNegotiationsReportAsExcel_Response, GenerateActiveNegotiationsReportAsExcel_Data, SetCounterparties_Data, SetCounterparties_Response, GetLegacyStatistics_Data, GetLegacyStatistics_Response, GetChannelTimeline_Data, SchemaAvailableAsCdm_Data, SchemaAvailableAsCdm_Response, RevokeWindow_Data, GetWindow_Data, GetWindow_Response, GrantWindow_Data, GrantWindow_Response, ExtendWindow_Data, ExtendWindow_Response, DeleteOfflineNegotiatedDocument_Data, DeleteOfflineNegotiatedDocument_Response, GetOfflineNegotiatedDocument_Data, GetOfflineNegotiatedDocument_Response, SetOfflineNegotiatedDocument_Data, SetOfflineNegotiatedDocument_Response, DeleteSignedExecutedVersion_Data, DeleteSignedExecutedVersion_Response, GetSignedExecutedVersion_Data, GetSignedExecutedVersion_Response, SetSignedExecutedVersion_Data, SetSignedExecutedVersion_Response, DeleteCoverNote_Data, DeleteCoverNote_Response, UpdateCoverNote_Data, UpdateCoverNote_Response, SendToCounterpartyInitial_Data, SendToCounterpartyInitial_Response, QueueGenerateNegotiationDocumentJob_Data, QueueGenerateNegotiationDocumentJob_Response, CreateSignaturePagePdf_Data, CreateSignaturePagePdf_Response, UpgradePresetSchema_Data, UpgradePresetSchema_Response, DocumentRenderTemplate_Data, DocumentRenderTemplate_Response, GetAccountRelationshipSummaries_Data, GetAccountRelationshipSummaries_Response, PresetRenderTemplate_Data, PresetRenderTemplate_Response, AddComment_Data, AddComment_Response, PresetSetElectionApproval_Data, PresetSetElectionApproval_Response, GetSsoConfig_Data, GetSsoConfig_Response, UpdateCustomFields_Data, UpdateCustomFields_Response, SendElectionApprovalReminder_Data, GetExecutedNegotiationSummary_Data, GetExecutedNegotiationSummary_Response, SwapParties_Data, SwapParties_Response, AcceptNestedAnswersCounterpartyPosition_Data, AcceptNestedAnswersCounterpartyPosition_Response, UpgradeSchema_Data, UpgradeSchema_Response, UpdateAttachDocx_Data, UpdateAttachDocx_Response, GetCompanyByEntityId_Data, GetCompanyByEntityId_Response, DeleteDraftingNotesDocument_Data, GetDraftingNotes_Data, GetDraftingNotes_Response, UpdateDraftingNotes_Data, UpdateDraftingNotes_Response, CreateAuditTrailPdf_Data, CreateAuditTrailPdf_Response, ListRecentExtractions_Data, ListRecentExtractions_Response, InitialAnswers_Data, InitialAnswers_Response, DownloadNegotiation_Data, DownloadNegotiation_Response, GetTimelineActivity_Data, GetProfile_Data, GetProfile_Response } from './types.gen';
|
|
4
|
+
import type { GetNegotiationDeltas_Data, GetAmendDefaults_Data, GetAmendDefaults_Response, NegotiationRenderTemplate_Data, NegotiationRenderTemplate_Response, CancelNegotiationsJobCount_Data, CancelNegotiationsJobCount_Response, AuditTrailForSubAccountAsJson_Data, AuditTrailForSubAccountAsJson_Response, GetDocumentSchema_Data, GetDocumentSchema_Response, AuditTrailForAccountAsJson_Data, AuditTrailForAccountAsJson_Response, SendBulkSetToCounterpartiesInitial_Data, SendBulkSetToCounterpartiesInitial_Response, GetWatchers_Data, GetWatchers_Response, AddWatchers_Data, AddWatchers_Response, GetUserStatistics_Data, GetUserStatistics_Response, RevertToAmending_Data, RevertToAmending_Response, SetReceiverEntity_Data, SetReceiverEntity_Response, MarkCommentEventsAsViewed_Data, PresetSetFinalApproval_Data, PresetSetFinalApproval_Response, AuthPing_Data, ListAllPresetsForSubAccountV1_Data, ListAllPresetsForSubAccountV1_Response, CreatePreset_Data, CreatePreset_Response, PresetGetMultipleNestedAnswers_Data, PresetGetMultipleNestedAnswers_Response, PresetSetMultipleNestedAnswers_Data, PresetSetMultipleNestedAnswers_Response, Approve_Data, Approve_Response, OverrideApproveFinalDocument_Data, DeleteEntity_Data, DeleteEntity_Response, GetSecurityContext_Data, GetSecurityContext_Response, UpdateSelectedElections_Data, UpdateSelectedElections_Response, GenerateAuditTrailForAccountAsExcel_Data, PresetEditAnswers_Data, PresetEditAnswers_Response, DeleteComment_Data, DeleteComment_Response, UpdateComment_Data, UpdateComment_Response, DeleteGeneralCoverNote_Data, DeleteGeneralCoverNote_Response, SetGeneralCoverNote_Data, SetGeneralCoverNote_Response, PublisherSummaries_Data, PublisherSummaries_Response, ValidateEntities_Data, ValidateEntities_Response, GrantAllNegotiationsAccess_Data, GrantAllNegotiationsAccess_Response, GetNegotiationESignStatus_Data, GetNegotiationESignStatus_Response, Unsubscribe_Data, OverrideRejectFinalDocument_Data, Version_Data, UpdateExtractionFeedback_Data, UpdateExtractionFeedback_Response, GetLatestDocumentSchema_Data, GetLatestDocumentSchema_Response, GetPreviousMajorVersionsNestedAnswerIds_Data, GetPreviousMajorVersionsNestedAnswerIds_Response, AddElectionRejection_Data, AddElectionRejection_Response, ListPresets_Data, ListPresets_Response, GetTimeline_Data, MarkEventsAsViewed_Data, NegotiationForkHistory_Data, NegotiationForkHistory_Response, MoveEntity_Data, MoveEntity_Response, ListEntities_Data, ListEntities_Response, ShareSubAccount_Data, ShareSubAccount_Response, AssignEntity_Data, AssignEntity_Response, SetFinalApproval_Data, SetFinalApproval_Response, SetElectionApproval_Data, SetElectionApproval_Response, DeleteApprovalComment_Data, EditApprovalComment_Data, EditApprovalComment_Response, DeleteExternalAttachment_Data, DeleteExternalAttachment_Response, GetExternalAttachment_Data, GetExternalAttachment_Response, ListPotentialNegotiationAdvisors_Data, ListPotentialNegotiationAdvisors_Response, GetAccessibleNegotiation_Data, GetAccessibleNegotiation_Response, GenerateNegotiationsReport_Data, ForkNegotiation_Data, ForkNegotiation_Response, AcceptAllCounterpartyPositions_Data, AcceptAllCounterpartyPositions_Response, NegotiationGetDocumentSchema_Data, NegotiationGetDocumentSchema_Response, UpdateGroupName_Data, ChangeSigningMode_Data, ChangeSigningMode_Response, SendToCounterparty_Data, SendToCounterparty_Response, VoidESignEnvelopeForNegotiation_Data, DeleteDocumentDraftingNote_Data, UpdateDocumentDraftingNote_Data, UpdateDocumentDraftingNote_Response, ShareNegotiation_Data, ShareNegotiation_Response, SetBulkSetAttachments_Data, SetBulkSetAttachments_Response, AddElectionApproval_Data, AddElectionApproval_Response, RejectFinalDocument_Data, GenerateAndMaybeSendEnvelope_Data, GetElectionAnswer_Data, GetElectionAnswer_Response, CreateAuditTrailJson_Data, CreateAuditTrailJson_Response, UpdateNegotiationsToMatch_Data, GetApprovalHistory_Data, GetApprovalHistory_Response, BulkSetsJobCount_Data, BulkSetsJobCount_Response, EditDefaultAnswers_Data, EditDefaultAnswers_Response, PresetSendForApproval_Data, PresetSendForApproval_Response, FixApprovalRules_Data, FixApprovalRules_Response, GetSubscribedPublishers_Data, GetSubscribedPublishers_Response, SendGroupToCounterparty_Data, SendGroupToCounterparty_Response, BreakingChanges_Data, BreakingChanges_Response, GetOtherPartyAnswers_Data, GetOtherPartyAnswers_Response, OverrideElectionRejection_Data, OverrideElectionRejection_Response, OverrideElectionApproval_Data, OverrideElectionApproval_Response, GetAllVersions_Data, GetAllVersions_Response, ListPotentialPresetAdvisors_Data, ListPotentialPresetAdvisors_Response, GetAsCdm_Data, GetAsCdm_Response, GetApprovalRound_Data, GetApprovalRound_Response, GetPreviousActiveUsers_Data, GetPreviousActiveUsers_Response, RevokePresetsAccess_Data, RevokePresetsAccess_Response, GrantPresetsAccess_Data, GrantPresetsAccess_Response, NotifyOfDraft_Data, RemoveWatchers_Data, RemoveWatchers_Response, GetNegotiation_Data, GetNegotiation_Response, UpdateMetadata_Data, UpdateMetadata_Response, GetDownloadExecutedNegotiationsAsExcel_Data, GetDownloadExecutedNegotiationsAsExcel_Response, GenerateExecutedNegotiationsReportAsExcel_Data, DeleteSignedSignaturePageForParty_Data, SetSignedSignaturePageForParty_Data, SetSignedSignaturePageForParty_Response, SuggestGroupName_Data, SuggestGroupName_Response, MarkActivityEventsAsViewed_Data, CancelExtraction_Data, CancelExtraction_Response, EditAnswers_Data, EditAnswers_Response, GetComments_Data, ContactForNewApprover_Data, GetDraftingNotesDocument_Data, GetDraftingNotesDocument_Response, AcceptAllPositionsFromFork_Data, AcceptAllPositionsFromFork_Response, AcceptAllPresetPositions_Data, AcceptAllPresetPositions_Response, SendChaserEmail_Data, CreateSigningPack_Data, CreateSigningPack_Response, GetGroupNames_Data, GetGroupNames_Response, CreateGroup_Data, CreateGroup_Response, GetNegotiationFilesSummary_Data, GetNegotiationFilesSummary_Response, GetUsers_Data, GetUsers_Response, GetSettings_Data, GetSettings_Response, Confirm_Data, Confirm_Response, SendDocumentApprovalReminder_Data, GetStatistics_Data, GetStatistics_Response, PresetSwapParties_Data, PresetSwapParties_Response, ApproveFinalDocument_Data, ResetUserAnswers_Data, ResetUserAnswers_Response, GetMajorVersions_Data, GetMajorVersions_Response, UpdateUserAnswers_Data, UpdateUserAnswers_Response, DeleteDocumentElectionDraftingNote_Data, UpdateDocumentElectionDraftingNote_Data, UpdateDocumentElectionDraftingNote_Response, AssignToMe_Data, AssignToMe_Response, UpdateGroupMembers_Data, GetSignedSignaturePagePdf_Data, GetSignedSignaturePagePdf_Response, PresetGetDocumentSchema_Data, PresetGetDocumentSchema_Response, ListSubAccounts_Data, DocumentsFilter_Data, DocumentsFilter_Response, MarkAsOffline_Data, MarkAsOffline_Response, CheckSignedSignaturePagePdf_Data, CheckSignedSignaturePagePdf_Response, GetAnnotatedOfflineNegotiatedDocument_Data, GetAnnotatedOfflineNegotiatedDocument_Response, DeleteAuxiliaryDocument_Data, DeleteAuxiliaryDocument_Response, GetAuxiliaryDocument_Data, GetAuxiliaryDocument_Response, SetAuxiliaryDocument_Data, SetAuxiliaryDocument_Response, DownloadPreExecutionCounterpartyNegotiation_Data, DownloadPreExecutionCounterpartyNegotiation_Response, Cancel_Data, Cancel_Response, RevokeNegotiationsAccess_Data, RevokeNegotiationsAccess_Response, GrantNegotiationsAccess_Data, GrantNegotiationsAccess_Response, ListDocuments_Data, ListDocuments_Response, GetPartyAnswers_Data, GetPartyAnswers_Response, DeletePreset_Data, GetPreset_Data, GetPreset_Response, CreatePresetAuditTrailJson_Data, CreatePresetAuditTrailJson_Response, GetPotentialUsers_Data, GetPotentialUsers_Response, GetNegotiationsGroup_Data, GetNegotiationsGroup_Response, ConsentCodeCallback_Data, GetOfflineNegotiatedDocumentAnnotations_Data, GetOfflineNegotiatedDocumentAnnotations_Response, AcceptAllCustodianTemplatePositions_Data, AcceptAllCustodianTemplatePositions_Response, AccountSummary_Data, AccountSummary_Response, GetApprovalComments_Data, GetApprovalComments_Response, ListAdvisorsForWorkspace_Data, ListAdvisorsForWorkspace_Response, CheckOfflineNegotiatedDocument_Data, CheckOfflineNegotiatedDocument_Response, DownloadPreset_Data, DownloadPreset_Response, AssignUser_Data, AssignUser_Response, GenerateCommentsReport_Data, GetExtractionResults_Data, GetExtractionResults_Response, ApplyExtractedAnswers_Data, ApplyExtractedAnswers_Response, GetOriginalAnswersForForkNegotiation_Data, GetOriginalAnswersForForkNegotiation_Response, MarkAsFinal_Data, MarkAsFinal_Response, GetPreviousMajorVersionsNestedAnswerElections_Data, GetPreviousMajorVersionsNestedAnswerElections_Response, ListNegotiations_Data, ListNegotiations_Response, CreateNegotiation_Data, CreateNegotiation_Response, PresetGetNestedAnswers_Data, PresetGetNestedAnswers_Response, PresetSetNestedAnswers_Data, PresetSetNestedAnswers_Response, CreatePresetAuditTrailXlsx_Data, CreatePresetAuditTrailXlsx_Response, ClonePreset_Data, ClonePreset_Response, ObtainConsent_Data, CheckAuxiliaryDocument_Data, CheckAuxiliaryDocument_Response, ListDocumentsWithPagination_Data, ListDocumentsWithPagination_Response, EmailPreferences_Data, EmailPreferences_Response, PatchEmailPreferences_Data, ConfirmExecutionVersion_Data, ConfirmExecutionVersion_Response, ListAllPresetsForSubAccountV2_Data, ListAllPresetsForSubAccountV2_Response, ListExternalAttachments_Data, ListExternalAttachments_Response, SetExternalAttachments_Data, SetExternalAttachments_Response, SetExternalAttachment_Data, SetExternalAttachment_Response, GenerateAuditTrailForSubAccountAsExcel_Data, ValidateDraftReceiverEmails_Data, ValidateDraftReceiverEmails_Response, DownloadPostExecutionPack_Data, DownloadPostExecutionPack_Response, MarkApprovalCommentsAsViewed_Data, AcceptCounterpartyPosition_Data, AcceptCounterpartyPosition_Response, CancelNegotiations_Data, CancelNegotiations_Response, GetNegotiationDraftingNotes_Data, GetNegotiationDraftingNotes_Response, AuditTrailFilters_Data, AuditTrailFilters_Response, GetCommentSummary_Data, DeleteExecutionAttachment_Data, DeleteExecutionAttachment_Response, GetExecutionAttachment_Data, GetExecutionAttachment_Response, GetUsersForPicker_Data, GetUsersForPicker_Response, SyncNewApprover_Data, GetMultipleNestedAnswers_Data, GetMultipleNestedAnswers_Response, SetMultipleNestedAnswers_Data, SetMultipleNestedAnswers_Response, GetDocument_Data, GetDocument_Response, ListBulkSets_Data, CreateBulkSet_Data, CreateBulkSet_Response, AddApprovalComment_Data, AddApprovalComment_Response, ScheduleExtraction_Data, ScheduleExtraction_Response, ApproveAccessRequest_Data, ApproveAccessRequest_Response, NegotiationsFilter_Data, NegotiationsFilter_Response, CreateAuditTrailXlsx_Data, CreateAuditTrailXlsx_Response, SetPreset_Data, SetPreset_Response, CheckForBrokenApprovers_Data, CheckForBrokenApprovers_Response, DeleteBulkSetAttachment_Data, DeleteBulkSetAttachment_Response, GetBulkSetAttachment_Data, GetBulkSetAttachment_Response, UsersWithNegotiationAccess_Data, UsersWithNegotiationAccess_Response, GetStatisticsOverview_Data, GetStatisticsOverview_Response, GetSubAccount_Data, UpdateSubAccount_Data, PresetRequestApproval_Data, PresetRequestApproval_Response, RejectPresetApproval_Data, RejectPresetApproval_Response, SetOwnerEntity_Data, SetOwnerEntity_Response, NegotiationSendForApproval_Data, NegotiationSendForApproval_Response, SearchEntity_Data, SearchEntity_Response, ListDocumentsVersionsSummary_Data, ListDocumentsVersionsSummary_Response, Retract_Data, Retract_Response, AcceptAllPositionsFromPreviousVersion_Data, AcceptAllPositionsFromPreviousVersion_Response, RenameExecutionAttachment_Data, RenameExecutionAttachment_Response, GetNestedAnswers_Data, GetNestedAnswers_Response, SetNestedAnswers_Data, SetNestedAnswers_Response, GetBulkSet_Data, GetBulkSet_Response, ListExecutionAttachments_Data, ListExecutionAttachments_Response, SetExecutionAttachments_Data, SetExecutionAttachments_Response, SetExecutionAttachment_Data, SetExecutionAttachment_Response, CheckSignedExecutedVersion_Data, CheckSignedExecutedVersion_Response, GetDownloadActiveNegotiationsReportAsExcel_Data, GetDownloadActiveNegotiationsReportAsExcel_Response, GenerateActiveNegotiationsReportAsExcel_Data, SetCounterparties_Data, SetCounterparties_Response, GetLegacyStatistics_Data, GetLegacyStatistics_Response, GetChannelTimeline_Data, SchemaAvailableAsCdm_Data, SchemaAvailableAsCdm_Response, RevokeWindow_Data, GetWindow_Data, GetWindow_Response, GrantWindow_Data, GrantWindow_Response, ExtendWindow_Data, ExtendWindow_Response, DeleteOfflineNegotiatedDocument_Data, DeleteOfflineNegotiatedDocument_Response, GetOfflineNegotiatedDocument_Data, GetOfflineNegotiatedDocument_Response, SetOfflineNegotiatedDocument_Data, SetOfflineNegotiatedDocument_Response, DeleteSignedExecutedVersion_Data, DeleteSignedExecutedVersion_Response, GetSignedExecutedVersion_Data, GetSignedExecutedVersion_Response, SetSignedExecutedVersion_Data, SetSignedExecutedVersion_Response, DeleteCoverNote_Data, DeleteCoverNote_Response, UpdateCoverNote_Data, UpdateCoverNote_Response, SendToCounterpartyInitial_Data, SendToCounterpartyInitial_Response, QueueGenerateNegotiationDocumentJob_Data, QueueGenerateNegotiationDocumentJob_Response, CreateSignaturePagePdf_Data, CreateSignaturePagePdf_Response, UpgradePresetSchema_Data, UpgradePresetSchema_Response, DocumentRenderTemplate_Data, DocumentRenderTemplate_Response, GetAccountRelationshipSummaries_Data, GetAccountRelationshipSummaries_Response, PresetRenderTemplate_Data, PresetRenderTemplate_Response, AddComment_Data, AddComment_Response, PresetSetElectionApproval_Data, PresetSetElectionApproval_Response, GetSsoConfig_Data, GetSsoConfig_Response, UpdateCustomFields_Data, UpdateCustomFields_Response, SendElectionApprovalReminder_Data, RejectAccessRequest_Data, RejectAccessRequest_Response, GetExecutedNegotiationSummary_Data, GetExecutedNegotiationSummary_Response, SwapParties_Data, SwapParties_Response, AcceptNestedAnswersCounterpartyPosition_Data, AcceptNestedAnswersCounterpartyPosition_Response, UpgradeSchema_Data, UpgradeSchema_Response, UpdateAttachDocx_Data, UpdateAttachDocx_Response, GetCompanyByEntityId_Data, GetCompanyByEntityId_Response, DeleteDraftingNotesDocument_Data, GetDraftingNotes_Data, GetDraftingNotes_Response, UpdateDraftingNotes_Data, UpdateDraftingNotes_Response, CreateAuditTrailPdf_Data, CreateAuditTrailPdf_Response, ListRecentExtractions_Data, ListRecentExtractions_Response, InitialAnswers_Data, InitialAnswers_Response, DownloadNegotiation_Data, DownloadNegotiation_Response, GetTimelineActivity_Data, GetProfile_Data, GetProfile_Response } from './types.gen';
|
|
5
5
|
import { client as _heyApiClient } from './client.gen';
|
|
6
6
|
|
|
7
7
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
|
|
@@ -388,6 +388,23 @@ export const presetSetMultipleNestedAnswers = <ThrowOnError extends boolean = fa
|
|
|
388
388
|
});
|
|
389
389
|
};
|
|
390
390
|
|
|
391
|
+
/**
|
|
392
|
+
* Approve a preset that has been sent for approval
|
|
393
|
+
* Approve a preset that has been sent for approval.
|
|
394
|
+
*/
|
|
395
|
+
export const approve = <ThrowOnError extends boolean = false>(options: Options<Approve_Data, ThrowOnError>) => {
|
|
396
|
+
return (options.client ?? _heyApiClient).put<Approve_Response, unknown, ThrowOnError>({
|
|
397
|
+
security: [
|
|
398
|
+
{
|
|
399
|
+
name: 'Authorization',
|
|
400
|
+
type: 'apiKey'
|
|
401
|
+
}
|
|
402
|
+
],
|
|
403
|
+
url: '/api/v1/presets/{presetId}/approvals/approve',
|
|
404
|
+
...options
|
|
405
|
+
});
|
|
406
|
+
};
|
|
407
|
+
|
|
391
408
|
/**
|
|
392
409
|
* Override Approve the final document before working towards Agreed form
|
|
393
410
|
* Override Approve the final document before working towards Agreed form.
|
|
@@ -895,6 +912,27 @@ export const listEntities = <ThrowOnError extends boolean = false>(options?: Opt
|
|
|
895
912
|
});
|
|
896
913
|
};
|
|
897
914
|
|
|
915
|
+
/**
|
|
916
|
+
* Share a workspace with specified users.
|
|
917
|
+
* Share a workspace with specified users. Grants or requests access to the workspace if required.
|
|
918
|
+
*/
|
|
919
|
+
export const shareSubAccount = <ThrowOnError extends boolean = false>(options: Options<ShareSubAccount_Data, ThrowOnError>) => {
|
|
920
|
+
return (options.client ?? _heyApiClient).post<ShareSubAccount_Response, unknown, ThrowOnError>({
|
|
921
|
+
security: [
|
|
922
|
+
{
|
|
923
|
+
name: 'Authorization',
|
|
924
|
+
type: 'apiKey'
|
|
925
|
+
}
|
|
926
|
+
],
|
|
927
|
+
url: '/api/v1/subAccounts/{subAccountId}/share',
|
|
928
|
+
...options,
|
|
929
|
+
headers: {
|
|
930
|
+
'Content-Type': 'application/json',
|
|
931
|
+
...options?.headers
|
|
932
|
+
}
|
|
933
|
+
});
|
|
934
|
+
};
|
|
935
|
+
|
|
898
936
|
/**
|
|
899
937
|
* Assign an entity to a Sub-Account
|
|
900
938
|
* Assign an entity to a subaccount.
|
|
@@ -1247,8 +1285,8 @@ export const updateDocumentDraftingNote = <ThrowOnError extends boolean = false>
|
|
|
1247
1285
|
};
|
|
1248
1286
|
|
|
1249
1287
|
/**
|
|
1250
|
-
* Share a negotiation with specified usesr.
|
|
1251
1288
|
* Share a negotiation with specified users.
|
|
1289
|
+
* Share a negotiation with specified users. Grants or requests access to the negotiations workspace if required.
|
|
1252
1290
|
*/
|
|
1253
1291
|
export const shareNegotiation = <ThrowOnError extends boolean = false>(options: Options<ShareNegotiation_Data, ThrowOnError>) => {
|
|
1254
1292
|
return (options.client ?? _heyApiClient).post<ShareNegotiation_Response, unknown, ThrowOnError>({
|
|
@@ -3686,6 +3724,23 @@ export const scheduleExtraction = <ThrowOnError extends boolean = false>(options
|
|
|
3686
3724
|
});
|
|
3687
3725
|
};
|
|
3688
3726
|
|
|
3727
|
+
/**
|
|
3728
|
+
* Approve a request to grant access to a workspace.
|
|
3729
|
+
* Approve a request to grant access to a workspace.
|
|
3730
|
+
*/
|
|
3731
|
+
export const approveAccessRequest = <ThrowOnError extends boolean = false>(options: Options<ApproveAccessRequest_Data, ThrowOnError>) => {
|
|
3732
|
+
return (options.client ?? _heyApiClient).put<ApproveAccessRequest_Response, unknown, ThrowOnError>({
|
|
3733
|
+
security: [
|
|
3734
|
+
{
|
|
3735
|
+
name: 'Authorization',
|
|
3736
|
+
type: 'apiKey'
|
|
3737
|
+
}
|
|
3738
|
+
],
|
|
3739
|
+
url: '/api/v1/subAccounts/{subAccountId}/accessRequest/{accessRequestId}/approve',
|
|
3740
|
+
...options
|
|
3741
|
+
});
|
|
3742
|
+
};
|
|
3743
|
+
|
|
3689
3744
|
/**
|
|
3690
3745
|
* Get the names of the matching items for the specified free text under a particular `filter`
|
|
3691
3746
|
* Get the names of the matching items for the specified free text under a particular `filter`.
|
|
@@ -3864,6 +3919,44 @@ export const updateSubAccount = <ThrowOnError extends boolean = false>(options:
|
|
|
3864
3919
|
});
|
|
3865
3920
|
};
|
|
3866
3921
|
|
|
3922
|
+
/**
|
|
3923
|
+
* Submit a preset for approval
|
|
3924
|
+
* Submit the preset for approval.
|
|
3925
|
+
*/
|
|
3926
|
+
export const presetRequestApproval = <ThrowOnError extends boolean = false>(options: Options<PresetRequestApproval_Data, ThrowOnError>) => {
|
|
3927
|
+
return (options.client ?? _heyApiClient).put<PresetRequestApproval_Response, unknown, ThrowOnError>({
|
|
3928
|
+
security: [
|
|
3929
|
+
{
|
|
3930
|
+
name: 'Authorization',
|
|
3931
|
+
type: 'apiKey'
|
|
3932
|
+
}
|
|
3933
|
+
],
|
|
3934
|
+
url: '/api/v1/presets/{presetId}/approvals/requestApproval',
|
|
3935
|
+
...options
|
|
3936
|
+
});
|
|
3937
|
+
};
|
|
3938
|
+
|
|
3939
|
+
/**
|
|
3940
|
+
* Reject a preset that has been sent for approval
|
|
3941
|
+
* Reject a preset that has been sent for approval.
|
|
3942
|
+
*/
|
|
3943
|
+
export const rejectPresetApproval = <ThrowOnError extends boolean = false>(options: Options<RejectPresetApproval_Data, ThrowOnError>) => {
|
|
3944
|
+
return (options.client ?? _heyApiClient).put<RejectPresetApproval_Response, unknown, ThrowOnError>({
|
|
3945
|
+
security: [
|
|
3946
|
+
{
|
|
3947
|
+
name: 'Authorization',
|
|
3948
|
+
type: 'apiKey'
|
|
3949
|
+
}
|
|
3950
|
+
],
|
|
3951
|
+
url: '/api/v1/presets/{presetId}/approvals/reject',
|
|
3952
|
+
...options,
|
|
3953
|
+
headers: {
|
|
3954
|
+
'Content-Type': 'application/json',
|
|
3955
|
+
...options?.headers
|
|
3956
|
+
}
|
|
3957
|
+
});
|
|
3958
|
+
};
|
|
3959
|
+
|
|
3867
3960
|
/**
|
|
3868
3961
|
* Set the initiating party's entity for a negotiation
|
|
3869
3962
|
* Set the initiating party's entity for a negotiation.
|
|
@@ -4677,6 +4770,23 @@ export const sendElectionApprovalReminder = <ThrowOnError extends boolean = fals
|
|
|
4677
4770
|
});
|
|
4678
4771
|
};
|
|
4679
4772
|
|
|
4773
|
+
/**
|
|
4774
|
+
* Reject a request to grant access to a workspace.
|
|
4775
|
+
* Reject a request to grant access to a workspace.
|
|
4776
|
+
*/
|
|
4777
|
+
export const rejectAccessRequest = <ThrowOnError extends boolean = false>(options: Options<RejectAccessRequest_Data, ThrowOnError>) => {
|
|
4778
|
+
return (options.client ?? _heyApiClient).put<RejectAccessRequest_Response, unknown, ThrowOnError>({
|
|
4779
|
+
security: [
|
|
4780
|
+
{
|
|
4781
|
+
name: 'Authorization',
|
|
4782
|
+
type: 'apiKey'
|
|
4783
|
+
}
|
|
4784
|
+
],
|
|
4785
|
+
url: '/api/v1/subAccounts/{subAccountId}/accessRequest/{accessRequestId}/reject',
|
|
4786
|
+
...options
|
|
4787
|
+
});
|
|
4788
|
+
};
|
|
4789
|
+
|
|
4680
4790
|
/**
|
|
4681
4791
|
* View metadata for an executed negotiation
|
|
4682
4792
|
* View metadata for an executed negotiation.
|
package/client/types.gen.ts
CHANGED
|
@@ -13,7 +13,7 @@ export type BulkSetsCountsDto = {
|
|
|
13
13
|
totalBulkSets: number;
|
|
14
14
|
};
|
|
15
15
|
|
|
16
|
-
export type AnalyticsEventType = 'PASSWORD_RESET_START' | 'PASSWORD_RESET_SUCCESS' | 'INVITATION_ACCEPTED' | 'LOGIN_START' | 'LOGIN' | 'SUPPORT_IMPERSONATED_USER_LOGIN' | 'LOGIN_REFRESH' | 'USER_REMOVED' | 'API_KEY_CREATED' | 'API_READ' | 'API_WRITE' | 'CREATE_PRESET' | 'PUBLISH_PRESET' | 'DURATION_NEW_PRESET_TO_FINALISE_PRESET' | 'DOCUMENT_COMMENT' | 'ELECTION_COMMENT' | 'NEGOTIATION_CREATED' | 'INITIAL_SEND_TO_COUNTERPARTY' | 'SEND_TO_COUNTERPARTY' | 'RECEIVER_DRAFT' | 'AMENDING' | 'AGREED' | 'FINAL_DOCUMENT_APPROVAL' | 'FINAL_DOCUMENT_REJECTION' | 'ELECTION_APPROVAL' | 'ELECTION_REJECTION' | 'ESIGN_CREATE_DRAFT' | 'ESIGN_SEND_FOR_SIGNING' | 'ESIGN_SIGNING_COMPLETE' | 'EXECUTED' | 'DURATION_CREATE_NEGOTIATION_TO_INITIAL_SEND_TO_CP' | 'DURATION_ACCEPT_INVITATION_TO_CONFIRM_OFFLINE_EXECUTION' | 'DURATION_ACCEPT_INVITATION_TO_CONFIRM_ESIGN_EXECUTION' | 'DOWNLOAD_NEGOTIATION_METADATA' | 'DOWNLOAD_COMPLETED_NEGOTIATIONS' | 'DOWNLOAD_NEGOTIATION_CDM' | 'ACCOUNT_CREATED' | 'COUNT_ACCOUNT_USER' | 'ACCOUNT_DISABLE' | 'ACCOUNT_DELETE' | 'ACCOUNT_COUNTERPARTY_COUNT' | 'EMAIL_DELIVERY' | 'EMAIL_BOUNCE' | 'EMAIL_OPEN' | 'EMAIL_CLICK' | 'EMAIL_UNSUBSCRIBE' | 'EXTRACTION_STARTED' | 'EXTRACTION_COMPLETE' | 'EXTRACTION_REVIEW_STARTED' | 'EXTRACTION_REVIEW_COMPLETE' | 'EXTRACTION_CANCELLED' | 'EXTRACTION_FAILED';
|
|
16
|
+
export type AnalyticsEventType = 'PASSWORD_RESET_START' | 'PASSWORD_RESET_SUCCESS' | 'INVITATION_ACCEPTED' | 'LOGIN_START' | 'LOGIN' | 'SUPPORT_IMPERSONATED_USER_LOGIN' | 'LOGIN_REFRESH' | 'USER_REMOVED' | 'API_KEY_CREATED' | 'API_READ' | 'API_WRITE' | 'CREATE_PRESET' | 'REQUEST_APPROVAL_PRESET' | 'PUBLISH_PRESET' | 'REJECT_PRESET' | 'DURATION_NEW_PRESET_TO_FINALISE_PRESET' | 'DOCUMENT_COMMENT' | 'ELECTION_COMMENT' | 'NEGOTIATION_CREATED' | 'INITIAL_SEND_TO_COUNTERPARTY' | 'SEND_TO_COUNTERPARTY' | 'RECEIVER_DRAFT' | 'AMENDING' | 'AGREED' | 'FINAL_DOCUMENT_APPROVAL' | 'FINAL_DOCUMENT_REJECTION' | 'ELECTION_APPROVAL' | 'ELECTION_REJECTION' | 'ESIGN_CREATE_DRAFT' | 'ESIGN_SEND_FOR_SIGNING' | 'ESIGN_SIGNING_COMPLETE' | 'EXECUTED' | 'DURATION_CREATE_NEGOTIATION_TO_INITIAL_SEND_TO_CP' | 'DURATION_ACCEPT_INVITATION_TO_CONFIRM_OFFLINE_EXECUTION' | 'DURATION_ACCEPT_INVITATION_TO_CONFIRM_ESIGN_EXECUTION' | 'DOWNLOAD_NEGOTIATION_METADATA' | 'DOWNLOAD_COMPLETED_NEGOTIATIONS' | 'DOWNLOAD_NEGOTIATION_CDM' | 'ACCOUNT_CREATED' | 'COUNT_ACCOUNT_USER' | 'ACCOUNT_DISABLE' | 'ACCOUNT_DELETE' | 'ACCOUNT_COUNTERPARTY_COUNT' | 'EMAIL_DELIVERY' | 'EMAIL_BOUNCE' | 'EMAIL_OPEN' | 'EMAIL_CLICK' | 'EMAIL_UNSUBSCRIBE' | 'EXTRACTION_STARTED' | 'EXTRACTION_COMPLETE' | 'EXTRACTION_REVIEW_STARTED' | 'EXTRACTION_REVIEW_COMPLETE' | 'EXTRACTION_CANCELLED' | 'EXTRACTION_FAILED';
|
|
17
17
|
|
|
18
18
|
/**
|
|
19
19
|
* A map of action name to boolean - true if the action can be performed, false otherwise. If and action cannot be performed a actionName_reason string property will be available that describes why that action is unavailable.
|
|
@@ -323,12 +323,6 @@ export type ValidInvitationResponseDto = {
|
|
|
323
323
|
firstName?: string;
|
|
324
324
|
};
|
|
325
325
|
|
|
326
|
-
export type ShareNegotiationRequestDto = {
|
|
327
|
-
generalMessage?: string;
|
|
328
|
-
accountUsers: Array<AccountUserShareDto>;
|
|
329
|
-
newUsers: Array<NewUserShareDto>;
|
|
330
|
-
};
|
|
331
|
-
|
|
332
326
|
export type ApprovalCountStatisticsDto = {
|
|
333
327
|
myPendingApprovals: PendingApprovalCountsDto;
|
|
334
328
|
teamPendingApprovals: PendingApprovalCountsDto;
|
|
@@ -1202,6 +1196,7 @@ export type AdvisorRelationshipExpandedDto = {
|
|
|
1202
1196
|
export type PresetSummaryDto = {
|
|
1203
1197
|
health: 'ok' | 'blocked';
|
|
1204
1198
|
isStage2Preset: boolean;
|
|
1199
|
+
state: PresetStateDto;
|
|
1205
1200
|
healthIssues: Array<'approvalrulesbroken' | 'schemaupgraderequired'>;
|
|
1206
1201
|
availableActions: PresetAvailableActionsDto;
|
|
1207
1202
|
lastAuthored: string;
|
|
@@ -1231,6 +1226,10 @@ export type UpdateUserProfileDto = {
|
|
|
1231
1226
|
subAccountIds?: Array<string>;
|
|
1232
1227
|
};
|
|
1233
1228
|
|
|
1229
|
+
export type UpdateAccountPresetApprovalsDto = {
|
|
1230
|
+
presetApprovals: boolean;
|
|
1231
|
+
};
|
|
1232
|
+
|
|
1234
1233
|
export type NestedAnswersSummariesWithAnswersDto = {
|
|
1235
1234
|
partyB?: PartyAnswersDto;
|
|
1236
1235
|
moderator?: PartyAnswersDto;
|
|
@@ -1423,6 +1422,12 @@ export type ESignAccountStatusDto = {
|
|
|
1423
1422
|
value: string;
|
|
1424
1423
|
};
|
|
1425
1424
|
|
|
1425
|
+
export type ShareRequestDto = {
|
|
1426
|
+
generalMessage?: string;
|
|
1427
|
+
accountUsers: Array<AccountUserShareDto>;
|
|
1428
|
+
newUsers: Array<NewUserShareDto>;
|
|
1429
|
+
};
|
|
1430
|
+
|
|
1426
1431
|
export type NegotiationGroupDto = {
|
|
1427
1432
|
id: string;
|
|
1428
1433
|
name: string;
|
|
@@ -1681,10 +1686,6 @@ export type DraftReceiverEmailValidationDto = {
|
|
|
1681
1686
|
additionalEmails?: Array<EmailWithErrorDto>;
|
|
1682
1687
|
};
|
|
1683
1688
|
|
|
1684
|
-
export type NegotiationGroupIdDto = {
|
|
1685
|
-
id: string;
|
|
1686
|
-
};
|
|
1687
|
-
|
|
1688
1689
|
export type NegotiationFilter_OlderThanPeriod_OlderThanPeriodValue = 'Older than 7 days' | 'Older than 14 days' | 'Older than 30 days';
|
|
1689
1690
|
|
|
1690
1691
|
export type ExecutedNegotiationSummaryDto_PartyDto = {
|
|
@@ -1712,6 +1713,20 @@ export type PendingApprovalCountsDto = {
|
|
|
1712
1713
|
electionLevelApprovals: number;
|
|
1713
1714
|
};
|
|
1714
1715
|
|
|
1716
|
+
export type NegotiationGroupIdDto = {
|
|
1717
|
+
id: string;
|
|
1718
|
+
};
|
|
1719
|
+
|
|
1720
|
+
export type PresetStateDto = {
|
|
1721
|
+
requestedAt?: string;
|
|
1722
|
+
requestedBy?: UserWithRoleDto;
|
|
1723
|
+
approvedAt?: string;
|
|
1724
|
+
approvedBy?: UserWithRoleDto;
|
|
1725
|
+
type: string;
|
|
1726
|
+
rejectedAt?: string;
|
|
1727
|
+
rejectedBy?: UserWithRoleDto;
|
|
1728
|
+
};
|
|
1729
|
+
|
|
1715
1730
|
export type PresetSingleWithPreviewAndMultipleNestedAnswersDto = PresetSingleWithPreviewDto & {
|
|
1716
1731
|
nestedAnswerFullSummaries: {
|
|
1717
1732
|
[key: string]: NestedAnswersSummariesWithPresetAnswersDto;
|
|
@@ -1791,6 +1806,7 @@ export type SubAccountSummaryDto = {
|
|
|
1791
1806
|
name: string;
|
|
1792
1807
|
entities: Array<EntityDto>;
|
|
1793
1808
|
users: Array<string>;
|
|
1809
|
+
presetApprovals: boolean;
|
|
1794
1810
|
id: string;
|
|
1795
1811
|
status: string;
|
|
1796
1812
|
};
|
|
@@ -1862,6 +1878,7 @@ export type ActivityTimelineSummaryDto = {
|
|
|
1862
1878
|
export type PresetSingleDto = {
|
|
1863
1879
|
health: 'ok' | 'blocked';
|
|
1864
1880
|
isStage2Preset: boolean;
|
|
1881
|
+
state: PresetStateDto;
|
|
1865
1882
|
subAccountId: string;
|
|
1866
1883
|
answers: PartyAnswersDto;
|
|
1867
1884
|
permittedAdvisors?: Array<AdvisorWithShareSettingDto>;
|
|
@@ -1975,7 +1992,7 @@ export type SignatureExistsDto_RequiredSignaturePageDto = {
|
|
|
1975
1992
|
sigPageId: string;
|
|
1976
1993
|
};
|
|
1977
1994
|
|
|
1978
|
-
export type EmailTemplate = 'userInvite' | 'accountInvite' | 'negotiationCreateAccountInvite' | 'negotiationOneLinkInvite' | 'registerSSOUser' | 'approversRemoved' | 'approversFixed' | 'userTaggedInComment' | 'userTaggedInApprovalComment' | 'shareNegotiation' | 'accessRequest' | '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';
|
|
1995
|
+
export type EmailTemplate = 'userInvite' | 'accountInvite' | 'negotiationCreateAccountInvite' | 'negotiationOneLinkInvite' | 'registerSSOUser' | 'approversRemoved' | 'approversFixed' | 'userTaggedInComment' | 'userTaggedInApprovalComment' | 'shareNegotiation' | 'shareSubAccount' | 'accessRequest' | 'accessRequestResponse' | 'presetApprovalRequested' | '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';
|
|
1979
1996
|
|
|
1980
1997
|
export type PartyRelativeRef = 'our' | 'counterparty';
|
|
1981
1998
|
|
|
@@ -2615,7 +2632,6 @@ export type AdminAccountDetailDto = {
|
|
|
2615
2632
|
accountName: string;
|
|
2616
2633
|
features: Array<FeatureDto>;
|
|
2617
2634
|
logoUrl?: string;
|
|
2618
|
-
apiUsers: Array<ApiUserSummaryDto>;
|
|
2619
2635
|
accountId: string;
|
|
2620
2636
|
pendingEntities: Array<EntityMetadataDto>;
|
|
2621
2637
|
advisors: Array<AccountAndSubAccountsDto>;
|
|
@@ -2625,6 +2641,8 @@ export type AdminAccountDetailDto = {
|
|
|
2625
2641
|
[key: string]: AccountIntegrationDataDto;
|
|
2626
2642
|
};
|
|
2627
2643
|
isOneLink: boolean;
|
|
2644
|
+
apiUsers: Array<ApiUserSummaryDto>;
|
|
2645
|
+
presetApprovals: boolean;
|
|
2628
2646
|
subAccounts: Array<SubAccountDto>;
|
|
2629
2647
|
availableActions: AccountAvailableActionsDto;
|
|
2630
2648
|
allowedDomains: Array<string>;
|
|
@@ -3236,10 +3254,11 @@ export type NotificationTypeDto = {
|
|
|
3236
3254
|
};
|
|
3237
3255
|
|
|
3238
3256
|
export type SubAccountDto = {
|
|
3239
|
-
subAccountId: string;
|
|
3240
|
-
subAccountName: string;
|
|
3241
|
-
entities: Array<EntityDto>;
|
|
3242
3257
|
createdByIntegratorClientId?: string;
|
|
3258
|
+
entities: Array<EntityDto>;
|
|
3259
|
+
subAccountName: string;
|
|
3260
|
+
subAccountId: string;
|
|
3261
|
+
presetApprovals: boolean;
|
|
3243
3262
|
};
|
|
3244
3263
|
|
|
3245
3264
|
export type DocumentIdWithDraftingNotesFlagDto = {
|
|
@@ -3545,6 +3564,10 @@ export type UseForgottenPasswordCodeRequestDto = {
|
|
|
3545
3564
|
newPassword: string;
|
|
3546
3565
|
};
|
|
3547
3566
|
|
|
3567
|
+
export type RejectPresetDto = {
|
|
3568
|
+
comment: string;
|
|
3569
|
+
};
|
|
3570
|
+
|
|
3548
3571
|
export type LegacyNegotiationStatisticsDto = {
|
|
3549
3572
|
counterpartyTurn: LegacySidedNegotiationCountsDto;
|
|
3550
3573
|
ourTurn: LegacySidedNegotiationCountsDto;
|
|
@@ -4266,6 +4289,31 @@ export type PresetSetMultipleNestedAnswers_Responses = {
|
|
|
4266
4289
|
|
|
4267
4290
|
export type PresetSetMultipleNestedAnswers_Response = PresetSetMultipleNestedAnswers_Responses[keyof PresetSetMultipleNestedAnswers_Responses];
|
|
4268
4291
|
|
|
4292
|
+
export type Approve_Data = {
|
|
4293
|
+
body?: never;
|
|
4294
|
+
path: {
|
|
4295
|
+
presetId: string;
|
|
4296
|
+
};
|
|
4297
|
+
query?: never;
|
|
4298
|
+
url: '/api/v1/presets/{presetId}/approvals/approve';
|
|
4299
|
+
};
|
|
4300
|
+
|
|
4301
|
+
export type Approve_Errors = {
|
|
4302
|
+
/**
|
|
4303
|
+
* Preset not found
|
|
4304
|
+
*/
|
|
4305
|
+
404: unknown;
|
|
4306
|
+
};
|
|
4307
|
+
|
|
4308
|
+
export type Approve_Responses = {
|
|
4309
|
+
/**
|
|
4310
|
+
* The approved preset
|
|
4311
|
+
*/
|
|
4312
|
+
200: PresetSingleDto;
|
|
4313
|
+
};
|
|
4314
|
+
|
|
4315
|
+
export type Approve_Response = Approve_Responses[keyof Approve_Responses];
|
|
4316
|
+
|
|
4269
4317
|
export type OverrideApproveFinalDocument_Data = {
|
|
4270
4318
|
body: ApprovalCommentDto;
|
|
4271
4319
|
path: {
|
|
@@ -4944,6 +4992,31 @@ export type ListEntities_Responses = {
|
|
|
4944
4992
|
|
|
4945
4993
|
export type ListEntities_Response = ListEntities_Responses[keyof ListEntities_Responses];
|
|
4946
4994
|
|
|
4995
|
+
export type ShareSubAccount_Data = {
|
|
4996
|
+
body: ShareRequestDto;
|
|
4997
|
+
path: {
|
|
4998
|
+
subAccountId: string;
|
|
4999
|
+
};
|
|
5000
|
+
query?: never;
|
|
5001
|
+
url: '/api/v1/subAccounts/{subAccountId}/share';
|
|
5002
|
+
};
|
|
5003
|
+
|
|
5004
|
+
export type ShareSubAccount_Errors = {
|
|
5005
|
+
/**
|
|
5006
|
+
* Invalid email address for one or more new users or one or more existing users doesnt exist
|
|
5007
|
+
*/
|
|
5008
|
+
400: unknown;
|
|
5009
|
+
};
|
|
5010
|
+
|
|
5011
|
+
export type ShareSubAccount_Responses = {
|
|
5012
|
+
/**
|
|
5013
|
+
* The workspace was either shared or approval was requested
|
|
5014
|
+
*/
|
|
5015
|
+
204: void;
|
|
5016
|
+
};
|
|
5017
|
+
|
|
5018
|
+
export type ShareSubAccount_Response = ShareSubAccount_Responses[keyof ShareSubAccount_Responses];
|
|
5019
|
+
|
|
4947
5020
|
export type AssignEntity_Data = {
|
|
4948
5021
|
body: EntityIdDto;
|
|
4949
5022
|
path: {
|
|
@@ -5599,7 +5672,7 @@ export type UpdateDocumentDraftingNote_Responses = {
|
|
|
5599
5672
|
export type UpdateDocumentDraftingNote_Response = UpdateDocumentDraftingNote_Responses[keyof UpdateDocumentDraftingNote_Responses];
|
|
5600
5673
|
|
|
5601
5674
|
export type ShareNegotiation_Data = {
|
|
5602
|
-
body:
|
|
5675
|
+
body: ShareRequestDto;
|
|
5603
5676
|
path: {
|
|
5604
5677
|
subAccountId: string;
|
|
5605
5678
|
negotiationId: string;
|
|
@@ -5617,9 +5690,9 @@ export type ShareNegotiation_Errors = {
|
|
|
5617
5690
|
|
|
5618
5691
|
export type ShareNegotiation_Responses = {
|
|
5619
5692
|
/**
|
|
5620
|
-
* The negotiation
|
|
5693
|
+
* The negotiation was either shared or approval was requested
|
|
5621
5694
|
*/
|
|
5622
|
-
|
|
5695
|
+
204: void;
|
|
5623
5696
|
};
|
|
5624
5697
|
|
|
5625
5698
|
export type ShareNegotiation_Response = ShareNegotiation_Responses[keyof ShareNegotiation_Responses];
|
|
@@ -9252,6 +9325,32 @@ export type ScheduleExtraction_Responses = {
|
|
|
9252
9325
|
|
|
9253
9326
|
export type ScheduleExtraction_Response = ScheduleExtraction_Responses[keyof ScheduleExtraction_Responses];
|
|
9254
9327
|
|
|
9328
|
+
export type ApproveAccessRequest_Data = {
|
|
9329
|
+
body?: never;
|
|
9330
|
+
path: {
|
|
9331
|
+
subAccountId: string;
|
|
9332
|
+
accessRequestId: string;
|
|
9333
|
+
};
|
|
9334
|
+
query?: never;
|
|
9335
|
+
url: '/api/v1/subAccounts/{subAccountId}/accessRequest/{accessRequestId}/approve';
|
|
9336
|
+
};
|
|
9337
|
+
|
|
9338
|
+
export type ApproveAccessRequest_Errors = {
|
|
9339
|
+
/**
|
|
9340
|
+
* The request has already been actioned
|
|
9341
|
+
*/
|
|
9342
|
+
409: unknown;
|
|
9343
|
+
};
|
|
9344
|
+
|
|
9345
|
+
export type ApproveAccessRequest_Responses = {
|
|
9346
|
+
/**
|
|
9347
|
+
* The request was approved
|
|
9348
|
+
*/
|
|
9349
|
+
204: void;
|
|
9350
|
+
};
|
|
9351
|
+
|
|
9352
|
+
export type ApproveAccessRequest_Response = ApproveAccessRequest_Responses[keyof ApproveAccessRequest_Responses];
|
|
9353
|
+
|
|
9255
9354
|
export type NegotiationsFilter_Data = {
|
|
9256
9355
|
body?: never;
|
|
9257
9356
|
path: {
|
|
@@ -9492,6 +9591,56 @@ export type UpdateSubAccount_Responses = {
|
|
|
9492
9591
|
200: unknown;
|
|
9493
9592
|
};
|
|
9494
9593
|
|
|
9594
|
+
export type PresetRequestApproval_Data = {
|
|
9595
|
+
body?: never;
|
|
9596
|
+
path: {
|
|
9597
|
+
presetId: string;
|
|
9598
|
+
};
|
|
9599
|
+
query?: never;
|
|
9600
|
+
url: '/api/v1/presets/{presetId}/approvals/requestApproval';
|
|
9601
|
+
};
|
|
9602
|
+
|
|
9603
|
+
export type PresetRequestApproval_Errors = {
|
|
9604
|
+
/**
|
|
9605
|
+
* Preset not found
|
|
9606
|
+
*/
|
|
9607
|
+
404: unknown;
|
|
9608
|
+
};
|
|
9609
|
+
|
|
9610
|
+
export type PresetRequestApproval_Responses = {
|
|
9611
|
+
/**
|
|
9612
|
+
* The submitted preset
|
|
9613
|
+
*/
|
|
9614
|
+
200: PresetSingleDto;
|
|
9615
|
+
};
|
|
9616
|
+
|
|
9617
|
+
export type PresetRequestApproval_Response = PresetRequestApproval_Responses[keyof PresetRequestApproval_Responses];
|
|
9618
|
+
|
|
9619
|
+
export type RejectPresetApproval_Data = {
|
|
9620
|
+
body: RejectPresetDto;
|
|
9621
|
+
path: {
|
|
9622
|
+
presetId: string;
|
|
9623
|
+
};
|
|
9624
|
+
query?: never;
|
|
9625
|
+
url: '/api/v1/presets/{presetId}/approvals/reject';
|
|
9626
|
+
};
|
|
9627
|
+
|
|
9628
|
+
export type RejectPresetApproval_Errors = {
|
|
9629
|
+
/**
|
|
9630
|
+
* Preset not found
|
|
9631
|
+
*/
|
|
9632
|
+
404: unknown;
|
|
9633
|
+
};
|
|
9634
|
+
|
|
9635
|
+
export type RejectPresetApproval_Responses = {
|
|
9636
|
+
/**
|
|
9637
|
+
* The rejected preset
|
|
9638
|
+
*/
|
|
9639
|
+
200: PresetSingleDto;
|
|
9640
|
+
};
|
|
9641
|
+
|
|
9642
|
+
export type RejectPresetApproval_Response = RejectPresetApproval_Responses[keyof RejectPresetApproval_Responses];
|
|
9643
|
+
|
|
9495
9644
|
export type SetOwnerEntity_Data = {
|
|
9496
9645
|
body: OwnerEntityDto;
|
|
9497
9646
|
path: {
|
|
@@ -10659,6 +10808,32 @@ export type SendElectionApprovalReminder_Responses = {
|
|
|
10659
10808
|
201: unknown;
|
|
10660
10809
|
};
|
|
10661
10810
|
|
|
10811
|
+
export type RejectAccessRequest_Data = {
|
|
10812
|
+
body?: never;
|
|
10813
|
+
path: {
|
|
10814
|
+
subAccountId: string;
|
|
10815
|
+
accessRequestId: string;
|
|
10816
|
+
};
|
|
10817
|
+
query?: never;
|
|
10818
|
+
url: '/api/v1/subAccounts/{subAccountId}/accessRequest/{accessRequestId}/reject';
|
|
10819
|
+
};
|
|
10820
|
+
|
|
10821
|
+
export type RejectAccessRequest_Errors = {
|
|
10822
|
+
/**
|
|
10823
|
+
* The request has already been actioned
|
|
10824
|
+
*/
|
|
10825
|
+
409: unknown;
|
|
10826
|
+
};
|
|
10827
|
+
|
|
10828
|
+
export type RejectAccessRequest_Responses = {
|
|
10829
|
+
/**
|
|
10830
|
+
* The request was rejected
|
|
10831
|
+
*/
|
|
10832
|
+
204: void;
|
|
10833
|
+
};
|
|
10834
|
+
|
|
10835
|
+
export type RejectAccessRequest_Response = RejectAccessRequest_Responses[keyof RejectAccessRequest_Responses];
|
|
10836
|
+
|
|
10662
10837
|
export type GetExecutedNegotiationSummary_Data = {
|
|
10663
10838
|
body?: never;
|
|
10664
10839
|
path: {
|