From c05f541189ab9d9d3a564c24135dff7e64d9d673 Mon Sep 17 00:00:00 2001 From: prafull-opensignlabs <93375423+prafull-opensignlabs@users.noreply.github.com> Date: Mon, 15 Sep 2025 14:05:28 +0530 Subject: [PATCH] Update docs as per v2.28.0 --- docs/docs/API-docs/v1.1/opensign.yaml | 55 +++++++++++++++++++++++++-- 1 file changed, 51 insertions(+), 4 deletions(-) diff --git a/docs/docs/API-docs/v1.1/opensign.yaml b/docs/docs/API-docs/v1.1/opensign.yaml index 58ee3b3fe..8c03304dd 100644 --- a/docs/docs/API-docs/v1.1/opensign.yaml +++ b/docs/docs/API-docs/v1.1/opensign.yaml @@ -104,6 +104,8 @@ paths: **total_credits:** The sum of **plan_credits** and **addon_credits**. This represents the total credits currently available for use. + **renewal_date:** The Subscription renewal date + operationId: getcredits responses: "200": @@ -4493,6 +4495,14 @@ components: type: string description: The email address of the person or organization that users can reply to. example: mailer@opensignlabs.com + merge_certificate: + type: boolean + description: | + true - This will ensure that the completion certificate is included in the final PDF document. However, please note that once merged, the certificate cannot be separated from the main document. + + false - If you choose not to merge, the completion certificate will be provided as a separate PDF file along with the signed document. + + If nothing is set, it will use the owner’s preferences. If the owner’s preferences are also not set, it will default to false. draftdocument_body: required: - file @@ -4574,9 +4584,18 @@ components: remind_once_in_every: type: number description: "Number of days between reminders. This is only applicable when auto_reminder is set to true." - example: 5 + example: 5, + merge_certificate: + type: boolean + description: | + true - This will ensure that the completion certificate is included in the final PDF document. However, please note that once merged, the certificate cannot be separated from the main document. + + false - If you choose not to merge, the completion certificate will be provided as a separate PDF file along with the signed document. + + If nothing is set, it will use the owner’s preferences. If the owner’s preferences are also not set, it will default to false. + example: false prefill: - $ref: '#/components/schemas/prefill' + $ref: '#/components/schemas/prefill' createdocument_body: required: - file @@ -4660,6 +4679,14 @@ components: type: number description: "Number of days between reminders. This is only applicable when auto_reminder is set to true." example: 5 + merge_certificate: + type: boolean + description: | + true - This will ensure that the completion certificate is included in the final PDF document. However, please note that once merged, the certificate cannot be separated from the main document. + + false - If you choose not to merge, the completion certificate will be provided as a separate PDF file along with the signed document. + + If nothing is set, it will use the owner’s preferences. If the owner’s preferences are also not set, it will default to false. prefill: $ref: '#/components/schemas/prefill' inline_response_200_1: @@ -4799,7 +4826,15 @@ components: remind_once_in_every: type: number description: "Number of days between reminders. This is only applicable when auto_reminder is set to true." - example: 5 + example: 5, + merge_certificate: + type: boolean + description: | + true - This will ensure that the completion certificate is included in the final PDF document. However, please note that once merged, the certificate cannot be separated from the main document. + + false - If you choose not to merge, the completion certificate will be provided as a separate PDF file along with the signed document. + + If nothing is set, it will use the owner’s preferences. If the owner’s preferences are also not set, it will default to false. prefill: $ref: '#/components/schemas/prefill' revokedocument: @@ -4976,7 +5011,15 @@ components: remind_once_in_every: type: number description: "Number of days between reminders. This is only applicable when auto_reminder is set to true." - example: 5 + example: 5, + merge_certificate: + type: boolean + description: | + true - This will ensure that the completion certificate is included in the final PDF document. However, please note that once merged, the certificate cannot be separated from the main document. + + false - If you choose not to merge, the completion certificate will be provided as a separate PDF file along with the signed document. + + If nothing is set, it will use the owner’s preferences. If the owner’s preferences are also not set, it will default to false. prefill: $ref: '#/components/schemas/prefill' inline_response_draft_200: @@ -5506,6 +5549,10 @@ components: total_credits: type: number example: 0 + renewal_date: + type: string + format: date + example: '2026-09-17T00:00:00.000Z' securitySchemes: x-api-token: type: apiKey