From 2ef608fa3375b6b9da5adb6defcb4239bd4b1fd0 Mon Sep 17 00:00:00 2001 From: prafull-opensignlabs <93375423+prafull-opensignlabs@users.noreply.github.com> Date: Mon, 13 May 2024 11:50:04 +0530 Subject: [PATCH] add resend mail api --- docs/docs/API-docs/opensign.yaml | 104 +++++++++++++++++++++++++++++-- 1 file changed, 100 insertions(+), 4 deletions(-) diff --git a/docs/docs/API-docs/opensign.yaml b/docs/docs/API-docs/opensign.yaml index e826f7897..d185f6724 100644 --- a/docs/docs/API-docs/opensign.yaml +++ b/docs/docs/API-docs/opensign.yaml @@ -288,7 +288,7 @@ paths: tags: - Documents summary: Create Document - description: "The Create Document API allows users to generate new documents by providing data with base64 encoded file.\n\nUpload you pdf in our [**Debug UI**](https://app.opensignlabs.com/debugpdf) here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF\n\n**Below widgets are supported in the document:**\n\nCommon parameters of widgets:\n- **type:** Indicates the type of widget.\n- **page:** Specifies the page number on which you want to place the respective widget.\n- **x, y:** Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values.\n- **w, h:** Represents the width and height of the widget. You can adjust these values using the debug UI.\n- **required:** Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.\n- **name:** Provides a different name for widgets if you are providing more than one widget.\n1. **signature:**\n```\n{\n \"type\":\"signature\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21\n}\n```\n2. **stamp:**\n```\n{\n \"type\":\"stamp\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"stamp\"\n }\n}\n```\n3. **initials:**\n```\n{\n \"type\":\"initials\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"initials\"\n }\n}\n```\n4. **email:**\n```\n{\n \"type\":\"email\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"email\"\n }\n}\n```\n5. **name:**\n```\n{\n \"type\":\"name\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"name\"\n }\n}\n```\n6. **job title:**\n```\n{\n \"type\":\"job title\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"job title\"\n }\n}\n```\n7. **company:**\n```\n{\n \"type\":\"company\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"company\"\n }\n}\n```\n8. **date:**\n```\n{\n \"type\":\"date\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"date\",\n \"default\": \"04-15-2024\",\n \"format\": \"mm-dd-yyyy\" \n }\n}\n ```\n- **default:** Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.\n- **format:** Specify the date format of your choice from the options below.\n - \"dd/MM/yyyy\",\n - \"dd-mm-yyyy\", \n - \"yyyy-mm-dd\", \n - \"mm.dd.yyyy\", \n - \"mm-dd-yyyy\", \n - \"mmm dd, yyyy\", \n - \"mmmm dd, yyyy\", \n - \"dd mmm, yyyy\", \n - \"dd mmmm, yyyy\"\n\n9. **textbox:**\n```\n{\n \"type\":\"textbox\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"textbox\",\n \"default\": \"name\",\n \"hint\": \"provide name\",\n \"regularexpression\":\"\"\n }\n}\n```\n- **default:** Provide a default value for the textbox (Optional).\n- **hint:** Provide a hint for the textbox (Optional).\n- **regularexpression:** Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).\n\n10. **checkbox:**\n```\n{\n \"type\":\"checkbox\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"checkbox\",\n \"values\": [\"male\", \"female\", \"other\"],\n \"selectedvalues\": [ \"male\", \"female\" ],\n \"readonly\": false, \n \"hidelabel\": false,\n \"validation\": {\n \"minselections\": 0, \n \"maxselections\": 0 \n }\n }\n}\n```\n- **values:** Provide options for the checkbox list.\n- **selectedvalues:** Provide values that need to be selected by default (Optional).\n- **readonly:** Set to true if you want to set the checkbox as readonly. By default, it's false\n- **hidelabel:** Set to true if you want to hide labels of the checkbox. By default, it's false.\n- **minselections:** Provide the minimum number of checkboxes that must be selected by the user.\n- **maxselections:** Provide the maximum number of checkboxes that can be selected by the user.\n\n11. **dropdown:**\n ```\n{\n \"type\":\"dropdown\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"dropdown\",\n \"values\": [\"male\", \"female\", \"other\"],\n \"default\": \"male\"\n }\n }\n}\n```\n- **values:** Provide options for the dropdown list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n12. **radio button:**\n```\n{\n \"type\":\"radio button\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"radio button\",\n \"values\": [\"male\", \"female\", \"other\"],\n \"default\": \"male\"\n }\n }\n}\n``` \n- **values:** Provide options for the radio button list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n13. **image:**\n```\n{\n \"type\":\"image\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"image\"\n }\n }\n}\n```\n" + description: "The Create Document API allows users to generate new documents by providing data with base64 encoded file.\n\nUpload you pdf in our [**Debug UI**](https://app.opensignlabs.com/debugpdf) here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF\n\n**Below widgets are supported in the document:**\n\nCommon parameters of widgets:\n- **type:** Indicates the type of widget.\n- **page:** Specifies the page number on which you want to place the respective widget.\n- **x, y:** Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values.\n- **w, h:** Represents the width and height of the widget. You can adjust these values using the debug UI.\n- **required:** Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.\n- **name:** Provides a different name for widgets if you are providing more than one widget.\n1. **signature:**\n```\n{\n \"type\":\"signature\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21\n}\n```\n- **Note:** At least one signature is required for each signer\n2. **stamp:**\n```\n{\n \"type\":\"stamp\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"stamp\"\n }\n}\n```\n3. **initials:**\n```\n{\n \"type\":\"initials\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"initials\"\n }\n}\n```\n4. **email:**\n```\n{\n \"type\":\"email\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"email\"\n }\n}\n```\n5. **name:**\n```\n{\n \"type\":\"name\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"name\"\n }\n}\n```\n6. **job title:**\n```\n{\n \"type\":\"job title\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"job title\"\n }\n}\n```\n7. **company:**\n```\n{\n \"type\":\"company\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"company\"\n }\n}\n```\n8. **date:**\n```\n{\n \"type\":\"date\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"date\",\n \"default\": \"04-15-2024\",\n \"format\": \"mm-dd-yyyy\" \n }\n}\n ```\n- **default:** Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.\n- **format:** Specify the date format of your choice from the options below.\n - \"dd/MM/yyyy\",\n - \"dd-mm-yyyy\", \n - \"yyyy-mm-dd\", \n - \"mm.dd.yyyy\", \n - \"mm-dd-yyyy\", \n - \"mmm dd, yyyy\", \n - \"mmmm dd, yyyy\", \n - \"dd mmm, yyyy\", \n - \"dd mmmm, yyy\"\n\n9. **textbox:**\n```\n{\n \"type\":\"textbox\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"textbox\",\n \"default\": \"name\",\n \"hint\": \"provide name\",\n \"regularexpression\":\"\"\n }\n}\n```\n- **default:** Provide a default value for the textbox (Optional).\n- **hint:** Provide a hint for the textbox (Optional).\n- **regularexpression:** Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).\n\n10. **checkbox:**\n```\n{\n \"type\":\"checkbox\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"checkbox\",\n \"values\": [\"male\", \"female\", \"other\"],\n \"selectedvalues\": [ \"male\", \"female\" ],\n \"readonly\": false, \n \"hidelabel\": false,\n \"validation\": {\n \"minselections\": 0, \n \"maxselections\": 0 \n }\n }\n}\n```\n- **values:** Provide options for the checkbox list.\n- **selectedvalues:** Provide values that need to be selected by default (Optional).\n- **readonly:** Set to true if you want to set the checkbox as readonly. By default, it's false\n- **hidelabel:** Set to true if you want to hide labels of the checkbox. By default, it's false.\n- **minselections:** Provide the minimum number of checkboxes that must be selected by the user.\n- **maxselections:** Provide the maximum number of checkboxes that can be selected by the user.\n\n11. **dropdown:**\n ```\n{\n \"type\":\"dropdown\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"dropdown\",\n \"values\": [\"male\", \"female\", \"other\"],\n \"default\": \"male\"\n }\n }\n}\n```\n- **values:** Provide options for the dropdown list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n12. **radio button:**\n```\n{\n \"type\":\"radio button\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"radio button\",\n \"values\": [\"male\", \"female\", \"other\"],\n \"default\": \"male\"\n }\n }\n}\n``` \n- **values:** Provide options for the radio button list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n13. **image:**\n```\n{\n \"type\":\"image\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"image\"\n }\n }\n}\n```\n" operationId: createdocument requestBody: content: @@ -578,12 +578,55 @@ paths: $ref: '#/components/schemas/invalidtoken' security: - x-api-token: [] + /resendmail: + post: + tags: + - Documents + summary: Resend request mail + description: | + Resend request mail to user for signing document. + operationId: Resendrequestmail + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/resendmail_body' + required: true + responses: + "200": + description: "" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_10' + "400": + description: "" + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_400_2' + "404": + description: | + - document not found if document id is not correct. + - user not found if provided user email is not present in signer list of document + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_404_1' + "405": + description: Invalid API Token! + content: + application/json: + schema: + $ref: '#/components/schemas/invalidtoken' + security: + - x-api-token: [] /createtemplate: post: tags: - Templates summary: Create Template - description: "The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.\n\nUpload you pdf in our [**Debug UI**](https://app.opensignlabs.com/debugpdf) here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF.\n\n**Below widgets are supported in the document:**\n\nCommon parameters of widgets:\n\n- **type:** Indicates the type of widget.\n- **page:** Specifies the page number on which you want to place the respective widget.\n- **x, y:** Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values.\n- **w, h:** Represents the width and height of the widget. You can adjust these values using the debug UI.\n- **required:** Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.\n- **name:** Provides a different name for widgets if you are providing more than one widget.\n1. **signature:**\n```\n{\n \"type\":\"signature\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21\n}\n```\n2. **stamp:**\n```\n{\n \"type\":\"stamp\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"stamp\"\n }\n}\n```\n3. **initials:**\n```\n{\n \"type\":\"initials\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"initials\"\n }\n}\n```\n4. **email:**\n```\n{\n \"type\":\"email\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"email\"\n }\n}\n```\n5. **name:**\n```\n{\n \"type\":\"name\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"name\"\n }\n}\n```\n6. **job title:**\n```\n{\n \"type\":\"job title\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"job title\"\n }\n}\n```\n7. **company:**\n```\n{\n \"type\":\"company\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"company\"\n }\n}\n```\n8. **date:**\n```\n{\n \"type\":\"date\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"date\",\n \"default\": \"04-15-2024\",\n \"format\": \"mm-dd-yyyy\" \n }\n}\n ```\n- **default:** Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.\n- **format:** Specify the date format of your choice from the options below.\n - \"dd/MM/yyyy\",\n - \"dd-mm-yyyy\", \n - \"yyyy-mm-dd\", \n - \"mm.dd.yyyy\", \n - \"mm-dd-yyyy\", \n - \"mmm dd, yyyy\", \n - \"mmmm dd, yyyy\", \n - \"dd mmm, yyyy\", \n - \"dd mmmm, yyyy\"\n\n9. **textbox:**\n```\n{\n \"type\":\"textbox\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"textbox\",\n \"default\": \"name\",\n \"hint\": \"provide name\",\n \"regularexpression\":\"\"\n }\n}\n```\n- **default:** Provide a default value for the textbox (Optional).\n- **hint:** Provide a hint for the textbox (Optional).\n- **regularexpression:** Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).\n\n10. **checkbox:**\n```\n{\n \"type\":\"checkbox\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"checkbox\",\n \"values\": [\"male\", \"female\", \"other\"],\n \"selectedvalues\": [ \"male\", \"female\" ],\n \"readonly\": false, \n \"hidelabel\": false,\n \"validation\": {\n \"minselections\": 0, \n \"maxselections\": 0 \n }\n }\n}\n```\n- **values:** Provide options for the checkbox list.\n- **selectedvalues:** Provide values that need to be selected by default (Optional).\n- **readonly:** Set to true if you want to set the checkbox as readonly. By default, it's false\n- **hidelabel:** Set to true if you want to hide labels of the checkbox. By default, it's false.\n- **minselections:** Provide the minimum number of checkboxes that must be selected by the user.\n- **maxselections:** Provide the maximum number of checkboxes that can be selected by the user.\n\n11. **dropdown:**\n ```\n{\n \"type\":\"dropdown\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"dropdown\",\n \"values\": [\"male\", \"female\", \"other\"],\n \"default\": \"male\"\n }\n }\n}\n```\n- **values:** Provide options for the dropdown list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n12. **radio button:**\n```\n{\n \"type\":\"radio button\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"radio button\",\n \"values\": [\"male\", \"female\", \"other\"],\n \"default\": \"male\"\n }\n }\n}\n``` \n- **values:** Provide options for the radio button list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n\n13. **image:**\n```\n{\n \"type\":\"image\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"image\"\n }\n }\n}\n``` \n" + description: "The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.\n\nUpload you pdf in our [**Debug UI**](https://app.opensignlabs.com/debugpdf) here you can draw widgets and copy co-oridnate, page number of them. also you can copy base64 of PDF.\n\n**Below widgets are supported in the document:**\n\nCommon parameters of widgets:\n\n- **type:** Indicates the type of widget.\n- **page:** Specifies the page number on which you want to place the respective widget.\n- **x, y:** Denotes the horizontal and vertical coordinates of the starting point of the widget. You can use the debug UI to determine these values.\n- **w, h:** Represents the width and height of the widget. You can adjust these values using the debug UI.\n- **required:** Set to false if you want to make the widget optional. By default, it's true. Not applicable for signature-type widgets.\n- **name:** Provides a different name for widgets if you are providing more than one widget.\n1. **signature:**\n```\n{\n \"type\":\"signature\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21\n}\n```\n2. **stamp:**\n```\n{\n \"type\":\"stamp\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"stamp\"\n }\n}\n```\n3. **initials:**\n```\n{\n \"type\":\"initials\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"initials\"\n }\n}\n```\n4. **email:**\n```\n{\n \"type\":\"email\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"email\"\n }\n}\n```\n5. **name:**\n```\n{\n \"type\":\"name\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"name\"\n }\n}\n```\n6. **job title:**\n```\n{\n \"type\":\"job title\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"job title\"\n }\n}\n```\n7. **company:**\n```\n{\n \"type\":\"company\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"company\"\n }\n}\n```\n8. **date:**\n```\n{\n \"type\":\"date\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"date\",\n \"default\": \"04-15-2024\",\n \"format\": \"mm-dd-yyyy\" \n }\n}\n ```\n- **default:** Provide the date from which you want to start the date of the date widget. Must be provided in the specified format. By default, today's date provided.\n- **format:** Specify the date format of your choice from the options below.\n - \"dd/MM/yyyy\",\n - \"dd-mm-yyyy\", \n - \"yyyy-mm-dd\", \n - \"mm.dd.yyyy\", \n - \"mm-dd-yyyy\", \n - \"mmm dd, yyyy\", \n - \"mmmm dd, yyyy\", \n - \"dd mmm, yyyy\", \n - \"dd mmmm, yyy\"\n\n9. **textbox:**\n```\n{\n \"type\":\"textbox\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"textbox\",\n \"default\": \"name\",\n \"hint\": \"provide name\",\n \"regularexpression\":\"\"\n }\n}\n```\n- **default:** Provide a default value for the textbox (Optional).\n- **hint:** Provide a hint for the textbox (Optional).\n- **regularexpression:** Provide regex for custom validation, such as allowing only numbers, only capital letters, etc. (Optional).\n\n10. **checkbox:**\n```\n{\n \"type\":\"checkbox\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"checkbox\",\n \"values\": [\"male\", \"female\", \"other\"],\n \"selectedvalues\": [ \"male\", \"female\" ],\n \"readonly\": false, \n \"hidelabel\": false,\n \"validation\": {\n \"minselections\": 0, \n \"maxselections\": 0 \n }\n }\n}\n```\n- **values:** Provide options for the checkbox list.\n- **selectedvalues:** Provide values that need to be selected by default (Optional).\n- **readonly:** Set to true if you want to set the checkbox as readonly. By default, it's false\n- **hidelabel:** Set to true if you want to hide labels of the checkbox. By default, it's false.\n- **minselections:** Provide the minimum number of checkboxes that must be selected by the user.\n- **maxselections:** Provide the maximum number of checkboxes that can be selected by the user.\n\n11. **dropdown:**\n ```\n{\n \"type\":\"dropdown\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"dropdown\",\n \"values\": [\"male\", \"female\", \"other\"],\n \"default\": \"male\"\n }\n }\n}\n```\n- **values:** Provide options for the dropdown list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n12. **radio button:**\n```\n{\n \"type\":\"radio button\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"radio button\",\n \"values\": [\"male\", \"female\", \"other\"],\n \"default\": \"male\"\n }\n }\n}\n``` \n- **values:** Provide options for the radio button list.\n- **default:** Provide the value that needs to be selected by default. Only one value is accepted. (Optional).\n\n13. **image:**\n```\n{\n \"type\":\"image\", \n \"page\":1, \n \"x\": 327, \n \"y\": 628, \n \"w\": 114, \n \"h\": 21, \n \"options\": {\n \"required\": true, \n \"name\": \"image\"\n }\n }\n}\n``` \n" operationId: createtemplate requestBody: content: @@ -1152,6 +1195,11 @@ components: type: string format: string example: sample Note + timeToCompleteDays: + type: number + description: time to complete days is used to calculate expiry date of your document + format: number + example: 15 signers: type: array items: @@ -1240,6 +1288,33 @@ components: sendInOrder: type: boolean example: false + timeToCompleteDays: + type: number + description: time to complete days is used to calculate expiry date of your document + format: number + example: 15 + resendmail_body: + required: + - document_id + - email + type: object + properties: + document_id: + type: string + example: provide document id + email: + type: string + description: | + provide user mail from signers to send request mail. + example: user@example.com + email_subject: + type: string + description: "Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}." + example: "" + email_body: + type: string + description: "Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}." + example: "" inline_response_200_2: type: object properties: @@ -1451,7 +1526,7 @@ components: email: type: string format: string - example: joebee@exampl.com + example: joebee@example.com name: type: string format: string @@ -1503,7 +1578,7 @@ components: email: type: string format: string - example: joebee@exampl.com + example: joebee@example.com name: type: string format: string @@ -1621,6 +1696,27 @@ components: type: number format: number example: 1 + inline_response_200_10: + type: object + properties: + result: + type: string + format: string + example: mail sent successfully. + inline_response_400_2: + type: object + properties: + error: + type: string + format: string + example: Something went wrong. + inline_response_404_1: + type: object + properties: + error: + type: string + format: string + example: document not found or user not found. securitySchemes: x-api-token: type: apiKey