@createiq/backend 1.0.26 → 1.0.27

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/dist/index.d.cts CHANGED
@@ -224,9 +224,11 @@ type RenderedTemplateDto = {
224
224
  };
225
225
  };
226
226
  type DocumentListDto = {
227
+ filter: FilterResultsDto;
227
228
  documents: Array<DocumentListItemDto>;
228
229
  pagingMeta: PagingMetaDto;
229
- filter: FilterResultsDto;
230
+ totalPhase2Templates: number;
231
+ totalTemplates: number;
230
232
  };
231
233
  type PublicAccountSearchResultsDto = {
232
234
  accountNames: Array<string>;
@@ -997,6 +999,7 @@ type DocumentListItemDto = {
997
999
  hasCustodianTemplates: boolean;
998
1000
  document: DocumentWithPackDto;
999
1001
  markedAsFavourite: boolean;
1002
+ templates: number;
1000
1003
  availableActions: DocumentListAvailableActionsDto;
1001
1004
  requestingUserCanInvite?: boolean;
1002
1005
  };
@@ -1731,7 +1734,7 @@ type SignatureExistsDto_RequiredSignaturePageDto = {
1731
1734
  exists: boolean;
1732
1735
  sigPageId: string;
1733
1736
  };
1734
- 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';
1737
+ type EmailTemplate = 'userInvite' | 'accountInvite' | 'negotiationCreateAccountInvite' | 'negotiationOneLinkInvite' | 'registerSSOUser' | 'approversRemoved' | 'approversFixed' | 'userTaggedInComment' | 'userTaggedInApprovalComment' | 'shareNegotiation' | 'shareSubAccount' | 'accessRequest' | 'accessRequestResponse' | 'presetApprovalRequested' | 'presetApprovalResponse' | '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';
1735
1738
  type PartyRelativeRef = 'our' | 'counterparty';
1736
1739
  type PresetOrderKey = 'name' | 'documentType' | 'status' | 'dateCreated';
1737
1740
  type BulkSetDto = {
@@ -7942,36 +7945,6 @@ type GetExecutionAttachment_Responses = {
7942
7945
  200: Blob | File;
7943
7946
  };
7944
7947
  type GetExecutionAttachment_Response = GetExecutionAttachment_Responses[keyof GetExecutionAttachment_Responses];
7945
- type GetUsersForPicker_Data = {
7946
- body?: never;
7947
- path: {
7948
- subAccountId: string;
7949
- };
7950
- query?: {
7951
- /**
7952
- * Include super managers (who are in all Sub-Accounts) in the response
7953
- */
7954
- includeSuperManagers?: boolean;
7955
- /**
7956
- * Include advisors in the response
7957
- */
7958
- includeAdvisors?: boolean;
7959
- };
7960
- url: '/api/v1/subaccount/{subAccountId}/usersForPicker';
7961
- };
7962
- type GetUsersForPicker_Errors = {
7963
- /**
7964
- * Sub-account not found
7965
- */
7966
- 404: unknown;
7967
- };
7968
- type GetUsersForPicker_Responses = {
7969
- /**
7970
- * List all of the users of the specified subaccount
7971
- */
7972
- 200: UserListForPickerDto;
7973
- };
7974
- type GetUsersForPicker_Response = GetUsersForPicker_Responses[keyof GetUsersForPicker_Responses];
7975
7948
  type SyncNewApprover_Data = {
7976
7949
  body: SyncNewApproverDto;
7977
7950
  path?: never;
@@ -8110,6 +8083,36 @@ type AddApprovalComment_Responses = {
8110
8083
  200: ApprovalCommentDto;
8111
8084
  };
8112
8085
  type AddApprovalComment_Response = AddApprovalComment_Responses[keyof AddApprovalComment_Responses];
8086
+ type GetUsersForPicker_Data = {
8087
+ body?: never;
8088
+ path: {
8089
+ subAccountId: string;
8090
+ };
8091
+ query?: {
8092
+ /**
8093
+ * Include super managers (who are in all Sub-Accounts) in the response
8094
+ */
8095
+ includeSuperManagers?: boolean;
8096
+ /**
8097
+ * Include advisors in the response
8098
+ */
8099
+ includeAdvisors?: boolean;
8100
+ };
8101
+ url: '/api/v1/subaccount/{subAccountId}/usersForPicker';
8102
+ };
8103
+ type GetUsersForPicker_Errors = {
8104
+ /**
8105
+ * Sub-account not found
8106
+ */
8107
+ 404: unknown;
8108
+ };
8109
+ type GetUsersForPicker_Responses = {
8110
+ /**
8111
+ * List all of the users of the specified subaccount
8112
+ */
8113
+ 200: UserListForPickerDto;
8114
+ };
8115
+ type GetUsersForPicker_Response = GetUsersForPicker_Responses[keyof GetUsersForPicker_Responses];
8113
8116
  type ScheduleExtraction_Data = {
8114
8117
  body?: never;
8115
8118
  path: {
@@ -10719,11 +10722,6 @@ declare const deleteExecutionAttachment: <ThrowOnError extends boolean = false>(
10719
10722
  * Download an execution attachment that has been uploaded for a negotiation.
10720
10723
  */
10721
10724
  declare const getExecutionAttachment: <ThrowOnError extends boolean = false>(options: Options<GetExecutionAttachment_Data, ThrowOnError>) => _hey_api_client_fetch.RequestResult<Blob | File, unknown, ThrowOnError>;
10722
- /**
10723
- * View a list of the active users in a Sub-Account.
10724
- * View a list of the active users in a Sub-Account. Returns a minimal set of data for the user picker. Returns only fully-registered users.
10725
- */
10726
- declare const getUsersForPicker: <ThrowOnError extends boolean = false>(options: Options<GetUsersForPicker_Data, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UserListForPickerDto, unknown, ThrowOnError>;
10727
10725
  /**
10728
10726
  * Assign a new approver to every approval for which an existing user is already an approver
10729
10727
  * Sync a given user to all the approval rules of an existing user for templates and in-flight and future negotiations. Optionally, replace a previous approver or restrict to a specific sub-account.
@@ -10761,6 +10759,11 @@ declare const createBulkSet: <ThrowOnError extends boolean = false>(options: Opt
10761
10759
  * Add an approval comment on a negotiation.
10762
10760
  */
10763
10761
  declare const addApprovalComment: <ThrowOnError extends boolean = false>(options: Options<AddApprovalComment_Data, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ApprovalCommentDto, unknown, ThrowOnError>;
10762
+ /**
10763
+ * View a list of the active users in a Sub-Account.
10764
+ * View a list of the active users in a Sub-Account. Returns a minimal set of data for the user picker. Returns only fully-registered users.
10765
+ */
10766
+ declare const getUsersForPicker: <ThrowOnError extends boolean = false>(options: Options<GetUsersForPicker_Data, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UserListForPickerDto, unknown, ThrowOnError>;
10764
10767
  /**
10765
10768
  * Extract answers from the offline negotiated document linked to the negotiation
10766
10769
  * Extract answers from the offline negotiated document linked to the negotiation.
package/dist/index.d.ts CHANGED
@@ -224,9 +224,11 @@ type RenderedTemplateDto = {
224
224
  };
225
225
  };
226
226
  type DocumentListDto = {
227
+ filter: FilterResultsDto;
227
228
  documents: Array<DocumentListItemDto>;
228
229
  pagingMeta: PagingMetaDto;
229
- filter: FilterResultsDto;
230
+ totalPhase2Templates: number;
231
+ totalTemplates: number;
230
232
  };
231
233
  type PublicAccountSearchResultsDto = {
232
234
  accountNames: Array<string>;
@@ -997,6 +999,7 @@ type DocumentListItemDto = {
997
999
  hasCustodianTemplates: boolean;
998
1000
  document: DocumentWithPackDto;
999
1001
  markedAsFavourite: boolean;
1002
+ templates: number;
1000
1003
  availableActions: DocumentListAvailableActionsDto;
1001
1004
  requestingUserCanInvite?: boolean;
1002
1005
  };
@@ -1731,7 +1734,7 @@ type SignatureExistsDto_RequiredSignaturePageDto = {
1731
1734
  exists: boolean;
1732
1735
  sigPageId: string;
1733
1736
  };
1734
- 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';
1737
+ type EmailTemplate = 'userInvite' | 'accountInvite' | 'negotiationCreateAccountInvite' | 'negotiationOneLinkInvite' | 'registerSSOUser' | 'approversRemoved' | 'approversFixed' | 'userTaggedInComment' | 'userTaggedInApprovalComment' | 'shareNegotiation' | 'shareSubAccount' | 'accessRequest' | 'accessRequestResponse' | 'presetApprovalRequested' | 'presetApprovalResponse' | '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';
1735
1738
  type PartyRelativeRef = 'our' | 'counterparty';
1736
1739
  type PresetOrderKey = 'name' | 'documentType' | 'status' | 'dateCreated';
1737
1740
  type BulkSetDto = {
@@ -7942,36 +7945,6 @@ type GetExecutionAttachment_Responses = {
7942
7945
  200: Blob | File;
7943
7946
  };
7944
7947
  type GetExecutionAttachment_Response = GetExecutionAttachment_Responses[keyof GetExecutionAttachment_Responses];
7945
- type GetUsersForPicker_Data = {
7946
- body?: never;
7947
- path: {
7948
- subAccountId: string;
7949
- };
7950
- query?: {
7951
- /**
7952
- * Include super managers (who are in all Sub-Accounts) in the response
7953
- */
7954
- includeSuperManagers?: boolean;
7955
- /**
7956
- * Include advisors in the response
7957
- */
7958
- includeAdvisors?: boolean;
7959
- };
7960
- url: '/api/v1/subaccount/{subAccountId}/usersForPicker';
7961
- };
7962
- type GetUsersForPicker_Errors = {
7963
- /**
7964
- * Sub-account not found
7965
- */
7966
- 404: unknown;
7967
- };
7968
- type GetUsersForPicker_Responses = {
7969
- /**
7970
- * List all of the users of the specified subaccount
7971
- */
7972
- 200: UserListForPickerDto;
7973
- };
7974
- type GetUsersForPicker_Response = GetUsersForPicker_Responses[keyof GetUsersForPicker_Responses];
7975
7948
  type SyncNewApprover_Data = {
7976
7949
  body: SyncNewApproverDto;
7977
7950
  path?: never;
@@ -8110,6 +8083,36 @@ type AddApprovalComment_Responses = {
8110
8083
  200: ApprovalCommentDto;
8111
8084
  };
8112
8085
  type AddApprovalComment_Response = AddApprovalComment_Responses[keyof AddApprovalComment_Responses];
8086
+ type GetUsersForPicker_Data = {
8087
+ body?: never;
8088
+ path: {
8089
+ subAccountId: string;
8090
+ };
8091
+ query?: {
8092
+ /**
8093
+ * Include super managers (who are in all Sub-Accounts) in the response
8094
+ */
8095
+ includeSuperManagers?: boolean;
8096
+ /**
8097
+ * Include advisors in the response
8098
+ */
8099
+ includeAdvisors?: boolean;
8100
+ };
8101
+ url: '/api/v1/subaccount/{subAccountId}/usersForPicker';
8102
+ };
8103
+ type GetUsersForPicker_Errors = {
8104
+ /**
8105
+ * Sub-account not found
8106
+ */
8107
+ 404: unknown;
8108
+ };
8109
+ type GetUsersForPicker_Responses = {
8110
+ /**
8111
+ * List all of the users of the specified subaccount
8112
+ */
8113
+ 200: UserListForPickerDto;
8114
+ };
8115
+ type GetUsersForPicker_Response = GetUsersForPicker_Responses[keyof GetUsersForPicker_Responses];
8113
8116
  type ScheduleExtraction_Data = {
8114
8117
  body?: never;
8115
8118
  path: {
@@ -10719,11 +10722,6 @@ declare const deleteExecutionAttachment: <ThrowOnError extends boolean = false>(
10719
10722
  * Download an execution attachment that has been uploaded for a negotiation.
10720
10723
  */
10721
10724
  declare const getExecutionAttachment: <ThrowOnError extends boolean = false>(options: Options<GetExecutionAttachment_Data, ThrowOnError>) => _hey_api_client_fetch.RequestResult<Blob | File, unknown, ThrowOnError>;
10722
- /**
10723
- * View a list of the active users in a Sub-Account.
10724
- * View a list of the active users in a Sub-Account. Returns a minimal set of data for the user picker. Returns only fully-registered users.
10725
- */
10726
- declare const getUsersForPicker: <ThrowOnError extends boolean = false>(options: Options<GetUsersForPicker_Data, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UserListForPickerDto, unknown, ThrowOnError>;
10727
10725
  /**
10728
10726
  * Assign a new approver to every approval for which an existing user is already an approver
10729
10727
  * Sync a given user to all the approval rules of an existing user for templates and in-flight and future negotiations. Optionally, replace a previous approver or restrict to a specific sub-account.
@@ -10761,6 +10759,11 @@ declare const createBulkSet: <ThrowOnError extends boolean = false>(options: Opt
10761
10759
  * Add an approval comment on a negotiation.
10762
10760
  */
10763
10761
  declare const addApprovalComment: <ThrowOnError extends boolean = false>(options: Options<AddApprovalComment_Data, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ApprovalCommentDto, unknown, ThrowOnError>;
10762
+ /**
10763
+ * View a list of the active users in a Sub-Account.
10764
+ * View a list of the active users in a Sub-Account. Returns a minimal set of data for the user picker. Returns only fully-registered users.
10765
+ */
10766
+ declare const getUsersForPicker: <ThrowOnError extends boolean = false>(options: Options<GetUsersForPicker_Data, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UserListForPickerDto, unknown, ThrowOnError>;
10764
10767
  /**
10765
10768
  * Extract answers from the offline negotiated document linked to the negotiation
10766
10769
  * Extract answers from the offline negotiated document linked to the negotiation.
package/dist/index.js CHANGED
@@ -2574,18 +2574,6 @@ var getExecutionAttachment = (options) => {
2574
2574
  ...options
2575
2575
  });
2576
2576
  };
2577
- var getUsersForPicker = (options) => {
2578
- return (options.client ?? client).get({
2579
- security: [
2580
- {
2581
- name: "Authorization",
2582
- type: "apiKey"
2583
- }
2584
- ],
2585
- url: "/api/v1/subaccount/{subAccountId}/usersForPicker",
2586
- ...options
2587
- });
2588
- };
2589
2577
  var syncNewApprover = (options) => {
2590
2578
  return (options.client ?? client).put({
2591
2579
  security: [
@@ -2690,6 +2678,18 @@ var addApprovalComment = (options) => {
2690
2678
  }
2691
2679
  });
2692
2680
  };
2681
+ var getUsersForPicker = (options) => {
2682
+ return (options.client ?? client).get({
2683
+ security: [
2684
+ {
2685
+ name: "Authorization",
2686
+ type: "apiKey"
2687
+ }
2688
+ ],
2689
+ url: "/api/v1/subaccount/{subAccountId}/usersForPicker",
2690
+ ...options
2691
+ });
2692
+ };
2693
2693
  var scheduleExtraction = (options) => {
2694
2694
  return (options.client ?? client).put({
2695
2695
  security: [