Reference
Queries#
documentRequestsInbox#
Requires: scope document_requests:read · feature document_requests.
documentRequestsInbox(profileId: ID!, status: DocumentRequestInboxStatus!, search: String, after: String): DocumentRequestPage!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
status | DocumentRequestInboxStatus! | |
search | String | |
after | String |
documentRequestDetail#
Requires: scope document_requests:read · feature document_requests.
documentRequestDetail(id: ID!): DocumentRequestDetail!
| Argument | Type | |
|---|---|---|
id | ID! |
documentRequestMessage#
Requires: scope document_requests:read · feature document_requests.
documentRequestMessage(id: ID!): DocumentRequestMessage!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
documentRequestMessages#
Requires: scope document_requests:read · feature document_requests.
documentRequestMessages(paging: CursorPaging!, filter: DocumentRequestMessageFilter!, sorting: [DocumentRequestMessageSort!]!): DocumentRequestMessageConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | DocumentRequestMessageFilter! | Specify to filter the records returned. |
sorting | [DocumentRequestMessageSort!]! | Specify to sort results. |
documentRequest#
Requires: scope document_requests:read · feature document_requests.
documentRequest(id: ID!): DocumentRequest!
| Argument | Type | |
|---|---|---|
id | ID! | The id of the record to find. |
documentRequests#
Requires: scope document_requests:read · feature document_requests.
documentRequests(paging: CursorPaging!, filter: DocumentRequestFilter!, sorting: [DocumentRequestSort!]!): DocumentRequestConnection!
| Argument | Type | |
|---|---|---|
paging | CursorPaging! | Limit or page results. |
filter | DocumentRequestFilter! | Specify to filter the records returned. |
sorting | [DocumentRequestSort!]! | Specify to sort results. |
Mutations#
createDocumentRequests#
Requires: scope document_requests:write · feature document_requests.
createDocumentRequests(profileId: ID!, input: [CreateDocumentRequestItemInput!]!): [DocumentRequest!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | [CreateDocumentRequestItemInput!]! |
addDocumentRequestMessage#
Requires: scope document_requests:write · feature document_requests.
addDocumentRequestMessage(documentRequestId: ID!, message: String!, attachments: [String!]): DocumentRequestMessage!
| Argument | Type | |
|---|---|---|
documentRequestId | ID! | |
message | String! | |
attachments | [String!] |
fulfillDocumentRequest#
Requires: scope document_requests:write · feature document_requests.
fulfillDocumentRequest(documentRequestId: ID!, files: [DocumentRequestFileUploadInput!]!, message: String): DocumentRequestDetail!
| Argument | Type | |
|---|---|---|
documentRequestId | ID! | |
files | [DocumentRequestFileUploadInput!]! | |
message | String |
answerDocumentRequest#
Requires: scope document_requests:write · feature document_requests.
answerDocumentRequest(input: AnswerDocumentRequestInput!): DocumentRequestDetail!
| Argument | Type | |
|---|---|---|
input | AnswerDocumentRequestInput! |
cancelDocumentRequest#
Requires: scope document_requests:write · feature document_requests.
cancelDocumentRequest(id: ID!): DocumentRequestDetail!
| Argument | Type | |
|---|---|---|
id | ID! |
createOneDocumentRequestMessage#
Requires: scope document_requests:write · feature document_requests.
createOneDocumentRequestMessage(documentRequestId: ID!, input: CreateDocumentRequestMessageInput!): DocumentRequestMessage!
| Argument | Type | |
|---|---|---|
documentRequestId | ID! | |
input | CreateDocumentRequestMessageInput! |
createManyDocumentRequestMessages#
Requires: scope document_requests:write · feature document_requests.
createManyDocumentRequestMessages(documentRequestId: ID!, input: [CreateDocumentRequestMessageInput!]!): [DocumentRequestMessage!]!
| Argument | Type | |
|---|---|---|
documentRequestId | ID! | |
input | [CreateDocumentRequestMessageInput!]! |
createOneDocumentRequest#
Requires: scope document_requests:write · feature document_requests.
createOneDocumentRequest(profileId: ID!, input: CreateDocumentRequestInput!): DocumentRequest!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | CreateDocumentRequestInput! |
createManyDocumentRequests#
Requires: scope document_requests:write · feature document_requests.
createManyDocumentRequests(profileId: ID!, input: [CreateDocumentRequestInput!]!): [DocumentRequest!]!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
input | [CreateDocumentRequestInput!]! |
updateOneDocumentRequestMessage#
Requires: scope document_requests:write · feature document_requests.
updateOneDocumentRequestMessage(input: UpdateOneDocumentRequestMessageInput!): DocumentRequestMessage!
| Argument | Type | |
|---|---|---|
input | UpdateOneDocumentRequestMessageInput! |
updateManyDocumentRequestMessages#
Requires: scope document_requests:write · feature document_requests.
updateManyDocumentRequestMessages(input: UpdateManyDocumentRequestMessagesInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManyDocumentRequestMessagesInput! |
deleteOneDocumentRequestMessage#
Requires: scope document_requests:write · feature document_requests.
deleteOneDocumentRequestMessage(input: DeleteOneDocumentRequestMessageInput!): DocumentRequestMessageDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOneDocumentRequestMessageInput! |
deleteManyDocumentRequestMessages#
Requires: scope document_requests:write · feature document_requests.
deleteManyDocumentRequestMessages(input: DeleteManyDocumentRequestMessagesInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManyDocumentRequestMessagesInput! |
updateOneDocumentRequest#
Requires: scope document_requests:write · feature document_requests.
updateOneDocumentRequest(input: UpdateOneDocumentRequestInput!): DocumentRequest!
| Argument | Type | |
|---|---|---|
input | UpdateOneDocumentRequestInput! |
updateManyDocumentRequests#
Requires: scope document_requests:write · feature document_requests.
updateManyDocumentRequests(input: UpdateManyDocumentRequestsInput!): UpdateManyResponse!
| Argument | Type | |
|---|---|---|
input | UpdateManyDocumentRequestsInput! |
deleteOneDocumentRequest#
Requires: scope document_requests:write · feature document_requests.
deleteOneDocumentRequest(input: DeleteOneDocumentRequestInput!): DocumentRequestDeleteResponse!
| Argument | Type | |
|---|---|---|
input | DeleteOneDocumentRequestInput! |
deleteManyDocumentRequests#
Requires: scope document_requests:write · feature document_requests.
deleteManyDocumentRequests(input: DeleteManyDocumentRequestsInput!): DeleteManyResponse!
| Argument | Type | |
|---|---|---|
input | DeleteManyDocumentRequestsInput! |