export interface paths { "/archive-documents/{archiveId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get archived document * @description Get a document from Signicat's document archive */ get: operations["getArchiveDocument"]; put?: never; post?: never; /** * Delete archived document * @description Delete a document from Signicat's document archive */ delete: operations["deleteArchivedDocument"]; options?: never; head?: never; patch?: never; trace?: never; }; "/documents/{documentId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get document * @description Get a document from Signicat's document storage backend */ get: operations["getSdsDocument"]; put?: never; post?: never; /** * Delete document * @description Delete a document from Signicat's document storage backend */ delete: operations["deleteFileOnSds"]; options?: never; head?: never; patch?: never; trace?: never; }; "/documents": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Upload session document * @description Upload a document to Signicat's session data storage */ post: operations["uploadFileToSds"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/orders": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create signing order * @description Create a new signing order */ post: operations["createRequest"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/orders/{orderId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get signing order * @description Return the signing order with the given ID */ get: operations["getSigningOrder"]; put?: never; post?: never; /** * Delete signing order * @description Delete an existing signing order */ delete: operations["deleteSigningOrder"]; options?: never; head?: never; patch?: never; trace?: never; }; "/orders/{orderId}/packaging-tasks/{packagingTaskId}/result": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get packaging task result document * @description Get the result document of a packaging task */ get: operations["getResultDocument"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/orders/{orderId}/packaging-tasks/{packagingTaskId}/status": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get packaging task status * @description Get the status of a packaging task */ get: operations["getStatus"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/orders/{orderId}/tasks/{taskId}/artifact": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Get the authentication artifact for a task * @description Generate the value of the authentication artifact. Replaces the old artifact if one exists. */ put: operations["createArtifact"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/orders/{orderId}/tasks/{taskId}/documents/{documentId}/generated": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get generated document * @description Get a generated document from Signicat's document storage */ get: operations["getGeneratedDocument"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/orders/{orderId}/tasks/{taskId}/documents/{documentId}/original": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get original document * @description Get an original document from Signicat's document storage */ get: operations["getOriginalDocument"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/orders/{orderId}/tasks/{taskId}/documents/{documentId}/result": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get signed document * @description Get a signed document from Signicat's document storage */ get: operations["getResultDocument_1"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/orders/{orderId}/tasks/{taskId}/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a list of task events * @description Get a list of events that have occurred on a task */ get: operations["getTaskEvents"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/orders/{orderId}/tasks/{taskId}/forwards": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a list describing details on the forwarding of this Task * @description Return information related to the forwarding of this task */ get: operations["getTaskForwardingInfos"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/orders/{orderId}/tasks/{taskId}/status": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get task status * @description Get signing order task current status */ get: operations["getStatus_1"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; } export type webhooks = Record; export interface components { schemas: { ClientProblem: { /** Format: int32 */ status?: number; type?: string; title?: string; detail?: string; }; DocumentRefId: { /** @example 0807201949xfrupvbzx7o07uihsihsx3xllslasvk8qtaojow3792xjucp */ documentId?: string; }; /** @description The Authentication data type describes how an end user may authenticate themselves before being presented with the documents */ Authentication: { /** * @description One or more methods. The method names should match the method definitions on the service. * @example [ * "nbid" * ] */ methods?: string[]; /** * @description Set to true if an authentication artifact should be generated * @example false */ artifact?: boolean; }; /** @description The Dialog data type describes a text message that is connected to a task or a specific document. The dialog message is presented on the web to the end user. */ Dialog: { /** * @description The title or header of the dialog message * @example Signing request */ title: string; /** * @description The message text * @example Please sign these documents */ message: string; }; /** @description The Document data type is used for describing a document upon which the end user should perform an action */ Document: { /** * @description A unique identifier for this document in the signing order * @example 7f5be5ec-650e-4d6e-9007-e420a7dd81aa */ id?: string; /** * @description A human readable description of the document. This description is used in the user Interface, and also part of the Signed Data Object for some eIDs. * @example Loan agreement */ description?: string; /** * @description The action that the end user is asked to perform on this document * @example SIGN * @enum {string} */ action: "SIGN" | "VIEW" | "UPLOAD"; /** * @description The source of the document * @example SESSION * @enum {string} */ source: "SESSION" | "UPLOAD"; /** * @description A reference to a document. If source is set to SESSION, this is the unique identifier of the document outside the signing order. If source is set to UPLOAD, then this should be omitted. * @example 0807201949xfrupvbzx7o07uihsihsx3xllslasvk8qtaojow3792xjucp */ documentRef?: string; /** * @description Optional information about the document that will be stored in the signed data object as an external reference. Only some SDO formats supports this. * @example 427bbe68-a161-11e9-a2a3-2a2ae2dbcce4 */ externalReference?: string; /** * @description Optional sign-text information that will be displayed to the end user in the final parts of the signing ceremony. May not be supported by all eID methods and document formats. Meant to be used for relatively short texts. Currently, the max length is 1024 chars. * @example ID: 134256 */ signTextEntry?: string; /** * @description If the signed or uploaded document is to be sent to the archive for permanent storage * @example false */ sendResultToArchive?: boolean; form?: components["schemas"]["Form"]; }; /** @description The Form data type is used when requesting an input form. This is only relevant if you are using Signicat Forms. */ Form: { /** @description Set to true if the form should be interactive */ interactive?: boolean; /** @description A list of parameters to be prefilled in the form */ inputParams?: components["schemas"]["FormParam"][]; }; /** @description The FormParam data type describes a specific parameter in a form */ FormParam: { /** @description The name of the parameter. This must match the name of the parameter in the form template. */ name: string; /** @description The value of the parameter */ value: string; }; /** @description Login hints are supplied as prefilled parameters to methods. */ LoginHint: { /** @description The name of the login hint. */ name: string; /** @description The value of the login hint. */ value: string; /** @description The methods for which to use the login hint. */ methods: string[]; }; /** @description The Method data type specifies the name of an eID method to use for signing, the type of the method and if a handwritten signature should be applied or not */ Method: { /** * @description The name of the eID method. If the name is specified, the type must also be specified. * @example nbid-sign */ name?: string; /** * @description The type of signature to create using the given method * @example SIGNED_STATEMENT * @enum {string} */ type?: "AUTHENTICATION_BASED" | "SIGNED_STATEMENT" | "THIRD_PARTY"; /** * @description Set to true if a handwritten signature should be applied after signing. If set to true with no method name given, only a handwritten signature will be requested. * @example false */ handwritten?: boolean; }; /** @description The NotificationTemplateParams contains values that will be inserted in stylized HTML email notifications. */ NotificationTemplateParams: { /** * @description A unique id for NotificationTemplateParams in the scope of the signing order.The id must be created by the client when the notification is created. * @example c68c7fd4-600c-4e4c-964e-8e8d15a24e61 */ id?: string; /** * @description The footer text of the email notification. Supports linebreaks. If no footer is supplied, a default footer will be used. * @example Footer text \n ©Signicat */ footer?: string; /** * @description The button text for email notification. If no button is supplied, no button element will be displayed. * @example Click here to sign */ button?: string; /** * @description An alternative linkText, will be followed by the task URL. If no linkText is supplied, no linkText element will be displayed in the email. * @example You can also copy this link into your browser */ linkText?: string; /** * @description The URL to be used for the logo image in the email notification. If no logoUrl is supplied, a default logo wil be used * @example https://developer.signicat.com/wp-content/uploads/2020/03/signicat-logo.png */ logoUrl?: string; }; /** @description The PackagingTask data type describes a packaging operation to be performed on one or more signed documents, e.g. packaging one or more XAdES documents into a single PAdES document. The input to the operation is a set of signed documents resulting from the regular tasks in the current request. For packaging across document action requests, the PackagingService must be used. */ PackagingTask: { /** * @description A unique identifier for this packaging task. The id must be specified by the client that creates the packaging task. The id must be unique among all ids in the Packaging Task list. * @example 83241c55-8813-495c-9d2f-390b6a39ea29 */ id?: string; /** * @description Set to true if the result of the packaging task is to be sent to the archive for permanent storage after it is packaged. Default value: false. * @example true */ sendToArchive?: boolean; /** * @description The name of the packaging method to be used in the packaging task. The method name should match the method definition on the service. * @example pades */ method: string; /** @description Notifications that should be sent out either when this packaging task is created or later (as specified in the notification). */ notifications?: components["schemas"]["PackagingTaskNotification"][]; /** @description Documents to be used as input to this packaging task. See the documentation of the PackagingTaskDocument data type. */ documents: components["schemas"]["PackagingTaskDocument"][]; }; /** @description The PackagingTask data type groups together signed documents that belong to the same task in order to be packed into a single PAdES document. */ PackagingTaskDocument: { /** * @description The unique identifier of the task * @example b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2 */ taskId?: string; /** * @description List of document IDs to include from the task with the given taskId. * @example [ * "7f5be5ec-650e-4d6e-9007-e420a7dd81aa" * ] */ documentIds: string[]; }; /** @description The PackagingTaskNotification data type describes a notification to an end user or to a system about a packaging task event in the system */ PackagingTaskNotification: { /** * @description A unique id for this notification in the scope of the signing order. The id must be created by the client when the notification is created. * @example e650b754-21dd-4c82-abc4-6f992bd4c271 */ id: string; /** * @description The address of the recipient of this notification * @example noreply@signicat.com */ recipient: string; /** * @description The address or name of the sender of this notification. Only relevant if the notification type is EMAIL or SMS. * @example signicat */ sender?: string; /** * @description The header or subject text of the Message. Only relevant if the notification type is EMAIL. * @example Packaging task completed. */ header?: string; /** * @description The message text in the notification. Formatting is not supported in notification messages. * @example A packaging task has been completed. */ message?: string; /** * @description The notification type * @example EMAIL * @enum {string} */ type: "SMS" | "EMAIL" | "URL"; /** @description A list of PackagingTaskSchedule objects. See the data type for PackagingTaskSchedule.If this field is missing, the notification will be sent once the packaging task is created. */ schedule?: components["schemas"]["PackagingTaskSchedule"][]; }; /** @description The PackagingTaskSchedule data type specifies when a packaging task notification should be sent. */ PackagingTaskSchedule: { /** * @description The status a packaging task needs to have in order to trigger a notification * @example COMPLETED * @enum {string} */ triggerStatus: "CREATED" | "COMPLETED" | "FAILED"; }; /** @description The SigingOrder data type describes a signing order for an action on one or more documents by one or more subjects. */ SigningOrder: { /** @description A read-only unique identifier for this SigningOrder. Any value set by the client will be ignored. */ readonly id?: string; /** * @description A read-only artifact for this SigningOrder. Any value set by the client will be ignored. * @example 9dda9sv2of79fgbwvwvj09w0a */ readonly artifact?: string; /** * @description A client specific reference. This value will not be used by the service, but will be returned to the client. * @example b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2 */ clientReference?: string; /** @description One or more tasks. See the documentation of the Task data type. */ tasks: components["schemas"]["Task"][]; /** @description One or more notifications that will be sent when the signing order has been completed */ notifications?: components["schemas"]["SigningOrderNotification"][]; /** * Format: int32 * @description The number of days before the signing order is automatically deleted from Signicat’s storage, after every task's days-to-live have passed. (see daysToLive on the Task element). Documents in the archive will not be deleted even if the signing order that created the documents is deleted. All documents that are not in the archive will be deleted. * @example 7 */ daysUntilDeletion?: number; packagingTasks?: components["schemas"]["PackagingTask"][]; /** @description A list of template params objects to be used to be used in task notifications of type EMAIL */ notificationTemplateParams?: components["schemas"]["NotificationTemplateParams"][]; }; /** @description The Notification data type describes a notification to an end user or to a system about an event in the system */ SigningOrderNotification: { /** * @description A unique id for this notification in the scope of the signing order. The id must be created by the client when the notification is created. * @example 25e0e0de-a171-11e9-a2a3-2a2ae2dbcce4 */ id: string; /** * @description The address of the recipient of this notification * @example noreply@signicat.com */ recipient: string; /** * @description The address or name of the sender of this notification. Only relevant if the notification type is EMAIL or SMS. * @example signicat */ sender?: string; /** * @description The header or subject text of the Message. Only relevant if the notification type is EMAIL. * @example Signingorder completed */ header?: string; /** * @description The message text in the notification. Formatting is not supported in notification messages. [Supports placeholders.](https://developer.signicat.com/enterprise/apis/sign/sign-api/#placeholders-in-notification-messages) * @example Ginny and Tinky have completed their tasks and the signing order with ID ${orderId} is completed. */ message?: string; /** * @description The notification type * @example EMAIL * @enum {string} */ type: "SMS" | "EMAIL" | "URL"; }; /** @description The subject data type specifies the subject that will be used to validate the signer after the signer has either signed the document(s) or authenticated himself or herself */ Subject: { /** * @description A unique identifier for this subject. The id must be specified by the client that creates the task. The id must be unique in the scope of the signing order. An id can only consist of characters A-Z, a-z, 0-9 and '-',i.e. “A”, “1”, “Agreement”, “Task123456” etc. The task id will be used in URLs and must not contain sensitive information. * @example u7s9ccdc-d79b-412e-a20e-03c2a8c8cdd2 */ id?: string; /** @description A list of attributes that are used to validate the signer after the signer has returned from the signing or authentication process */ attributes?: components["schemas"]["SubjectAttribute"][]; /** @description A list of login hints to be passed as prefilled parameters to the method. */ loginHints?: components["schemas"]["LoginHint"][]; }; /** @description The subject attribute data type specifies the attributes that will be used to validate the signer after the signer has either signed the document(s) or authenticated himself or herself */ SubjectAttribute: { /** * @description The name of the attribute to validate against. * @example national-id */ name: string; /** * @description The value of the attribute to validate against. * @example 10109001290 */ value: string; /** * @description The ID method or methods to use for validating the attribute value. If set, this attribute will override the specified name and will match only the corresponding value for the given method. * @example [ * "nbid-sign" * ] */ methods?: string[]; }; /** @description The Task data type describes a specific task for an end user. A task could be to sign one or more documents or to open and view a document. A task can require the end user to log in. A task will always have one and only one end user (subject). */ Task: { /** * @description A unique identifier for this task. The id must be specified by the client that creates the task. The id must be unique in the scope of the signing order. An id can only consist of characters A-Z, a-z, 0-9 and '-',i.e. “A”, “1”, “Agreement”, “Task123456” etc. The task id will be used in URLs and must not contain sensitive information. * @example b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2 */ id?: string; /** * @description The name of the graphical profile to use * @example default */ profile?: string; /** * @description A two-letter language code. E.g.: en, nb, sv, fi, da * @example nb */ language?: string; /** * Format: int32 * @description The number of days from the task is created until the task times out. The end user will not be allowed to access or perform any operation on the task after this deadline. * @example 7 */ daysToLive?: number; /** * @description The name of a Responsive Signflow configuration * @example pades */ configuration?: string; /** @description A list of the documents in the task */ documents: components["schemas"]["Document"][]; /** @description Specifies the eID signature methods that the end user may use to sign documents */ signatureMethods: components["schemas"]["Method"][]; authentication?: components["schemas"]["Authentication"]; /** * @description The URL where the end user should be returned if they choose to postpone the task * @example https://mydomain.com/postpone */ onTaskPostpone?: string; /** * @description The URL where the end user should be returned when the task is completed * @example https://mydomain.com/complete */ onTaskComplete?: string; /** * @description The URL where the end user should be returned if the task is cancelled * @example https://mydomain.com/reject */ onTaskReject?: string; dialog?: components["schemas"]["Dialog"]; /** @description A list of notifications that should be sent out either when the task is created or later (as specified in the notification) */ notifications?: components["schemas"]["TaskNotification"][]; /** @description The text that will be displayed to the end user as part of the signing process and is intended to describe thedocuments, the context and other information about the documents. If configured this field will override the document->signTextEntry field */ signText?: string; subject?: components["schemas"]["Subject"]; /** @description A list of Task IDs from this Signing Order that this Task depends on. The current Task will not be started before all Tasks in this list are completed. */ dependsOnTasks?: string[]; /** * @description The URL for the end user to initiate signing. May not be present if Artifact Authentication was used. * @example https://preprod.signicat.com/std/docaction/demo?request_id=2509202069ye6tqxwsz50m8of4z21zegn2ukxury1bfbgml8v9dvzlzimd&task_id=b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2 */ readonly signingUrl?: string; /** * @description Use legacy document viewer. Highly recommended to leave this 'false' or 'null' for everything but BIDXML documents * @default false */ useLegacyDocumentViewer: boolean; }; /** @description The TaskNotification data type describes a notification to an end user or to a system about a task event in the system */ TaskNotification: { /** @description An ID referring to the template params to be used. Only relevant if the notification type is EMAIL. If no notificationTemplateParamsId is supplied, the notification will not be HTML stylized */ notificationTemplateParamsId?: string; /** * @description A unique id for this notification in the scope of the signing order. The id must be created by the client when the notification is created. * @example c68c7fd4-600c-4e4c-964e-8e8d15a24e61 */ id: string; /** * @description The address of the recipient of this notification * @example noreply@signicat.com */ recipient: string; /** * @description The address or name of the sender of this notification. Only relevant if the notification type is EMAIL or SMS. * @example signicat */ sender?: string; /** * @description The header or subject text of the Message. Only relevant if the notification type is EMAIL. * @example Task completed */ header?: string; /** * @description The message text in the notification. Formatting is not supported in notification messages. [Supports placeholders.](https://developer.signicat.com/enterprise/apis/sign/sign-api/#placeholders-in-notification-messages) * @example A task belonging to the signing order with ID ${orderId} has been completed. */ message?: string; /** * @description The notification type * @example EMAIL * @enum {string} */ type: "SMS" | "EMAIL" | "URL"; /** @description A list of TaskSchedule objects. See the data type for TaskSchedule.If this field is missing, the notification will be sent once the task is created. */ schedule?: components["schemas"]["TaskSchedule"][]; }; /** @description The TaskSchedule data type specifies when a task notification should be sent. */ TaskSchedule: { /** * @description The status a task needs to have in order to trigger a notification * @example COMPLETED * @enum {string} */ triggerStatus: "CREATED" | "STARTED" | "COMPLETED" | "REJECTED" | "EXPIRED" | "FORWARDED"; delay?: components["schemas"]["TaskScheduleDelay"]; }; /** @description The Task Schedule Delay data type describes the delay before sending a notification after it has entered its scheduled state defined by triggerStatus. The total delay is = days + hours + minutes. */ TaskScheduleDelay: { /** * Format: int32 * @description The number of minutes this notification is delayed when the triggerStatus condition is met. When the signing order gets deleted this notification will become obsolete * @example 30 */ minutes?: number; /** * Format: int32 * @description The number of hours this notification is delayed when the triggerStatus condition is met. When the signing order gets deleted this notification will become obsolete * @example 12 */ hours?: number; /** * Format: int32 * @description The number of days this notification is delayed when the triggerStatus condition is metWhen the signing order gets deleted this notification will become obsolete * @example 7 */ days?: number; }; /** @description The PackagingTaskStatusInfo data type describes the status of a specific packaging task */ PackagingTaskStatusInfo: { /** * @description The unique identifier of the signing order * @example 05022019298twl5n4wo4soavolfwnxev9rxfghqapyk8junju1wxqamkeq */ orderId?: string; /** * @description The unique identifier of the packaging task * @example f727d294-a3b9-49c7-af99-4a217fc1d8fd */ packagingTaskId?: string; /** * @description The status of the packaging task * @example COMPLETED * @enum {string} */ packagingTaskStatus?: "CREATED" | "COMPLETED" | "FAILED"; /** * @description URI to the result of the packaging operation * @example https://api.signicat.com/enterprise/sign/orders//packaging-tasks//result */ packagingTaskResultUri?: string; }; Artifact: { /** * @description The authentication artifact * @example brcbedszcdzl040nuhn9wmh9g */ artifact?: string; /** * @description The unique identifier of the signing order * @example 05022019298twl5n4wo4soavolfwnxev9rxfghqapyk8junju1wxqamkeq */ orderId?: string; /** * @description The unique identifier of the task (is omitted if task status is “deleted”) * @example 537c8bf6-9b02-49d7-97d1-8d7ad2be36bf */ taskId?: string; /** * @description The URL for the end user to initiate signing. May not be present if Artifact Authentication was used. * @example https://preprod.signicat.com/std/docaction/demo?request_id=2509202069ye6tqxwsz50m8of4z21zegn2ukxury1bfbgml8v9dvzlzimd&task_id=b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2?artifact=brcbedszcdzl040nuhn9wmh9g */ signingUrl?: string; }; /** @description The Event data type describes an event that has occurred in the signing order */ Event: { /** * @description The type of the event that has occured * @example notification-sent * @enum {string} */ eventType?: "TASK_CREATED" | "NOTIFICATION_SENT" | "TASK_STARTED" | "TASK_REJECTED" | "TASK_POSTPONED" | "TASK_COMPLETED" | "TASK_FORWARDED" | "ERROR" | "DOCUMENT_UPLOADED" | "DOCUMENT_SIGNED" | "DOCUMENT_VIEWED" | "DOCUMENT_SIGN_CANCELLED" | "DOCUMENT_DELETED" | "USER_AUTHENTICATED" | "USER_AUTHENTICATION_CANCELLED" | "PACKAGING_TASK_CREATED" | "PACKAGING_TASK_COMPLETED" | "PACKAGING_TASK_FAILED" | "INTERNAL"; /** * Format: date-time * @description The time of the event. The pattern will be "yyyy-MM-dd'T'HH:mm:ssZ". */ eventTime?: string; /** * @description Some event types define additional data to give more detail about the event that occurred * @example Notification by EMAIL was sent to noreply@signicat.com */ data?: string; }; /** @description The ForwardingInfo data type describes the status and information related to forwarding of a task */ ForwardingInfo: { /** * @description The unique identifier of the signing order * @example 05022019298twl5n4wo4soavolfwnxev9rxfghqapyk8junju1wxqamkeq */ orderId?: string; /** * @description The unique identifier of the task created by forwarding the original task * @example 537c8bf6-9b02-49d7-97d1-8d7ad2be36bf */ taskId?: string; /** * @description The unique identifier of the original task that was forwarded * @example b8a5ccdc-d79b-412e-a20e-03c2a8c8cdd2 */ originalTaskId?: string; /** * @description The name of the person forwarding this task * @example Ola Nordmann */ forwarderName?: string; /** * @description The email of the person forwarding this task * @example olanordmann@example.com */ forwarderEmail?: string; /** * @description The name of the person receiving this task * @example Kari Nordmann */ recipientName?: string; /** * @description The email of the person receiving this task * @example kari@example.com */ recipientEmail?: string; /** * @description The mobile number of the person receiving this task * @example +4711223344 */ recipientMobile?: string; }; /** @description The DocumentStatus data type describes a document as part of the given task */ DocumentStatus: { /** * @description The unique identifier of the original document in the signing order * @example fbcf52a7-a952-41fc-82d9-beefbe094f6f */ id?: string; /** * @description URI for the original document * @example https://api.signicat.com/enterprise/sign/orders//documents//original */ originalUri?: string; /** * @description URI for the generated document * @example https://api.signicat.com/enterprise/sign/orders//tasks//documents//generated */ generatedUri?: string; /** * @description URI for the result document * @example https://api.signicat.com/enterprise/sign/orders//tasks//documents//result */ resultUri?: string; /** @description Form parameters that were either prefilled and/or filled in by the end user */ formOutputParam?: components["schemas"]["FormParam"][]; }; /** @description The TaskStatusInfo data type describes the status for a specific task */ TaskStatusInfo: { /** * @description The unique identifier of the signing order * @example 05022019298twl5n4wo4soavolfwnxev9rxfghqapyk8junju1wxqamkeq */ orderId?: string; /** * @description The unique identifier of the task (is omitted if task status is “deleted”) * @example 537c8bf6-9b02-49d7-97d1-8d7ad2be36bf */ taskId?: string; /** * @description The status for this task * @example COMPLETED * @enum {string} */ taskStatus?: "CREATED" | "COMPLETED" | "REJECTED" | "EXPIRED" | "DELETED"; /** * @description The client reference that was registered with this task, if any * @example d8e75ef7-6b3c-4511-b2ee-2b419a0c5cea */ clientReference?: string; /** * @description The last client status that was registered on this task, if any * @example fbcf52a7-a952-41fc-82d9-beefbe094f6f */ clientStatus?: string; /** @description A list with status info for each of the documents in the task, provided the task status is COMPLETED */ documents?: components["schemas"]["DocumentStatus"][]; /** * @description A reason for rejecting the task, given by the end user * @example The document was written in Klingon, while I only speak Sindarin */ rejectReason?: string; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { getArchiveDocument: { parameters: { query?: never; header?: never; path: { /** * @description The ID of the document stored in Signicat's document archive. * @example 200320193lrce4j85hpgdns4ivbuts5dy7pgarm1e0iozjq4qh2tey77jv */ archiveId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The archived document was successfully retrieved. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": string; "application/pdf": string; "text/plain": string; }; }; }; }; deleteArchivedDocument: { parameters: { query?: never; header?: never; path: { /** * @description The ID of the document stored in Signicat's document archive. * @example 200320193lrce4j85hpgdns4ivbuts5dy7pgarm1e0iozjq4qh2tey77jv */ archiveId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The archived document was successfully deleted. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description The document was not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; }; }; getSdsDocument: { parameters: { query?: never; header?: never; path: { documentId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The document was successfully retrieved */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": string; "application/pdf": string; "text/plain": string; "application/x-ltv-sdo": string; }; }; /** @description The documentID is invalid */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; /** @description The documentID was not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; }; }; deleteFileOnSds: { parameters: { query?: never; header?: never; path: { documentId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The document was successfully deleted */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description The documentID is invalid */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; /** @description The documentID was not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; }; }; uploadFileToSds: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/pdf": string; "text/plain": string; "text/bidxml": string; "application/x-ltv-sdo": string; }; }; responses: { /** @description The session document was succesfully uploaded */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DocumentRefId"]; }; }; /** @description Cannot open or read supplied PDF */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; /** @description The uploaded document cannot be empty */ 411: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; /** @description The uploaded document cannot be password protected */ 415: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; }; }; createRequest: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["SigningOrder"]; }; }; responses: { /** @description The signing order was successfully created */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SigningOrder"]; }; }; /** @description The signing order is not valid */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; }; }; getSigningOrder: { parameters: { query?: never; header?: never; path: { orderId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The signing order was successfully retrieved */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SigningOrder"]; }; }; /** @description The signing order was not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; }; }; deleteSigningOrder: { parameters: { query?: never; header?: never; path: { orderId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The signing order was successfully deleted */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description The signing order id is invalid */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; /** @description The signing order was not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; }; }; getResultDocument: { parameters: { query?: never; header?: never; path: { packagingTaskId: string; orderId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The packaging task result document was successfully retrieved */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": string; "application/pdf": string; "application/x-pades": string; }; }; /** @description The document can be downloaded in another endpoint specified by the Location header */ 303: { headers: { [name: string]: unknown; }; content?: never; }; /** @description The packagingTaskID is not valid */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; /** @description The document was not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; }; }; getStatus: { parameters: { query?: never; header?: never; path: { packagingTaskId: string; orderId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The packaging task status was successfully retrieved */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PackagingTaskStatusInfo"]; }; }; /** @description The packagingTaskID was not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; }; }; createArtifact: { parameters: { query?: never; header?: never; path: { taskId: string; orderId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The retrieved artifact along with information about the task */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Artifact"]; }; }; /** @description The artifact could not be retireved */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; }; }; getGeneratedDocument: { parameters: { query?: never; header?: never; path: { documentId: string; taskId: string; orderId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The generated document was successfully retrieved */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": string; "application/pdf": string; }; }; /** @description The documentID is not valid */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; /** @description The documentID was not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; }; }; getOriginalDocument: { parameters: { query?: never; header?: never; path: { documentId: string; taskId: string; orderId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The original document was successfully retrieved */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": string; "application/pdf": string; "text/plain": string; }; }; /** @description The documentID is not valid */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; /** @description The documentID was not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; }; }; getResultDocument_1: { parameters: { query?: never; header?: never; path: { documentId: string; taskId: string; orderId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The signed document was successfully retrieved */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": string; "application/pdf": string; "text/plain": string; }; }; /** @description The signed document is stored in document archive */ 303: { headers: { [name: string]: unknown; }; content?: never; }; /** @description The documentID is not valid */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; /** @description The documentID was not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; }; }; getTaskEvents: { parameters: { query?: never; header?: never; path: { taskId: string; orderId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The task's events were successfully retrieved */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Event"][]; }; }; /** @description The taskID was not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; }; }; getTaskForwardingInfos: { parameters: { query?: never; header?: never; path: { taskId: string; orderId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The forwarding information was successfully retrieved */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ForwardingInfo"][]; }; }; /** @description The task was not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; }; }; getStatus_1: { parameters: { query?: never; header?: never; path: { taskId: string; orderId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The task status was successfully retrieved */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TaskStatusInfo"]; }; }; /** @description The task was not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ClientProblem"]; }; }; }; }; }