Skip to content

Commit 620274e

Browse files
Merge pull request #2058 from OpenSignLabs/prafull-opensignlabs-patch-9
Add min_date and max_date to date configurations
2 parents 0994f80 + dfb5b1b commit 620274e

1 file changed

Lines changed: 140 additions & 15 deletions

File tree

docs/docs/API-docs/v1.1/opensign.yaml

Lines changed: 140 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,9 @@ paths:
476476
"default": "04-15-2024",
477477
"format": "mm-dd-yyyy",
478478
"color": "black",
479-
"fontsize": 12
479+
"fontsize": 12,
480+
"min_date": "",
481+
"max_date": ""
480482
}
481483
}
482484
```
@@ -493,7 +495,9 @@ paths:
493495
- "dd mmmm, yyy",
494496
- "dd/mm/yyyy",
495497
- "dd.mm.yyyy".
496-
498+
- **min_date:** Provide the minimum restriction date. The date must be in **YYYY-MM-DD** format.
499+
- **max_date:** Provide the maximum restriction date. The date must be in **YYYY-MM-DD** format.
500+
497501
9. **textbox**
498502
```
499503
{
@@ -808,7 +812,9 @@ paths:
808812
"default": "04-15-2024",
809813
"format": "mm-dd-yyyy",
810814
"color": "black",
811-
"fontsize": 12
815+
"fontsize": 12,
816+
"min_date": "",
817+
"max_date": ""
812818
}
813819
}
814820
```
@@ -825,6 +831,8 @@ paths:
825831
- "dd mmmm, yyy",
826832
- "dd/mm/yyyy",
827833
- "dd.mm.yyyy".
834+
- **min_date:** Provide the minimum restriction date. The date must be in **YYYY-MM-DD** format.
835+
- **max_date:** Provide the maximum restriction date. The date must be in **YYYY-MM-DD** format.
828836
829837
9. **textbox**
830838
```
@@ -1317,7 +1325,9 @@ paths:
13171325
"default": "04-15-2024",
13181326
"format": "mm-dd-yyyy",
13191327
"color": "black",
1320-
"fontsize": 12
1328+
"fontsize": 12,
1329+
"min_date": "",
1330+
"max_date": ""
13211331
}
13221332
}
13231333
```
@@ -1334,6 +1344,8 @@ paths:
13341344
- "dd mmmm, yyy",
13351345
- "dd/mm/yyyy",
13361346
- "dd.mm.yyyy".
1347+
- **min_date:** Provide the minimum restriction date. The date must be in **YYYY-MM-DD** format.
1348+
- **max_date:** Provide the maximum restriction date. The date must be in **YYYY-MM-DD** format.
13371349
13381350
9. **textbox**
13391351
```
@@ -1723,9 +1735,13 @@ paths:
17231735
{
17241736
"name": "date",
17251737
"readonly": false,
1726-
"default": "11-05-2025"
1738+
"default": "11-05-2025",
1739+
"min_date": "",
1740+
"max_date": ""
17271741
}
17281742
```
1743+
- **min_date:** Provide the minimum restriction date. The date must be in **YYYY-MM-DD** format.
1744+
- **max_date:** Provide the maximum restriction date. The date must be in **YYYY-MM-DD** format.
17291745
17301746
6. **textbox**
17311747
```
@@ -2286,7 +2302,6 @@ paths:
22862302
security:
22872303
- x-api-token: []
22882304
/drafttemplate:
2289-
22902305
post:
22912306
tags:
22922307
- Templates
@@ -2469,7 +2484,9 @@ paths:
24692484
"default": "04-15-2024",
24702485
"format": "mm-dd-yyyy",
24712486
"color": "black",
2472-
"fontsize": 12
2487+
"fontsize": 12,
2488+
"min_date": "",
2489+
"max_date": ""
24732490
}
24742491
}
24752492
```
@@ -2486,6 +2503,8 @@ paths:
24862503
- "dd mmmm, yyy",
24872504
- "dd/mm/yyyy",
24882505
- "dd.mm.yyyy".
2506+
- **min_date:** Provide the minimum restriction date. The date must be in **YYYY-MM-DD** format.
2507+
- **max_date:** Provide the maximum restriction date. The date must be in **YYYY-MM-DD** format.
24892508
24902509
9. **textbox**
24912510
```
@@ -2999,7 +3018,9 @@ paths:
29993018
"default": "04-15-2024",
30003019
"format": "mm-dd-yyyy",
30013020
"color": "black",
3002-
"fontsize": 12
3021+
"fontsize": 12,
3022+
"min_date": "",
3023+
"max_date": ""
30033024
}
30043025
}
30053026
```
@@ -3016,6 +3037,8 @@ paths:
30163037
- "dd mmmm, yyy",
30173038
- "dd/mm/yyyy",
30183039
- "dd.mm.yyyy".
3040+
- **min_date:** Provide the minimum restriction date. The date must be in **YYYY-MM-DD** format.
3041+
- **max_date:** Provide the maximum restriction date. The date must be in **YYYY-MM-DD** format.
30193042
30203043
9. **textbox**
30213044
```
@@ -3529,7 +3552,9 @@ paths:
35293552
"default": "04-15-2024",
35303553
"format": "mm-dd-yyyy",
35313554
"color": "black",
3532-
"fontsize": 12
3555+
"fontsize": 12,
3556+
"min_date": "",
3557+
"max_date": ""
35333558
}
35343559
}
35353560
```
@@ -3546,6 +3571,8 @@ paths:
35463571
- "dd mmmm, yyy",
35473572
- "dd/mm/yyyy",
35483573
- "dd.mm.yyyy".
3574+
- **min_date:** Provide the minimum restriction date. The date must be in **YYYY-MM-DD** format.
3575+
- **max_date:** Provide the maximum restriction date. The date must be in **YYYY-MM-DD** format.
35493576
35503577
9. **textbox**
35513578
```
@@ -4970,7 +4997,7 @@ components:
49704997
job_title:
49714998
type: string
49724999
format: string
4973-
example: dev
5000+
example: dev
49745001
folder_body:
49755002
required:
49765003
- foldername
@@ -5084,7 +5111,21 @@ components:
50845111
**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.
50855112
50865113
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.
5087-
example: false
5114+
example: false
5115+
notify_on_signatures:
5116+
type: boolean
5117+
example: false
5118+
description: |
5119+
**true** - The document creator will receive an email notification whenever a signer signs the document.
5120+
5121+
**false** - The document creator will not receive an email notification whenever a signer signs the document.
5122+
5123+
Note: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on 'send_email' parameter.
5124+
pen_colors:
5125+
type: array
5126+
items:
5127+
type: string
5128+
example: ["blue", "red", "black"]
50885129
draftdocument_body:
50895130
required:
50905131
- file
@@ -5176,6 +5217,20 @@ components:
51765217
51775218
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.
51785219
example: false
5220+
notify_on_signatures:
5221+
type: boolean
5222+
example: false
5223+
description: |
5224+
**true** - The document creator will receive an email notification whenever a signer signs the document.
5225+
5226+
**false** - The document creator will not receive an email notification whenever a signer signs the document.
5227+
5228+
Note: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on 'send_email' parameter.
5229+
pen_colors:
5230+
type: array
5231+
items:
5232+
type: string
5233+
example: ["blue", "red", "black"]
51795234
prefill:
51805235
$ref: '#/components/schemas/prefill'
51815236
createdocument_body:
@@ -5269,7 +5324,21 @@ components:
52695324
**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.
52705325
52715326
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.
5272-
example: false
5327+
example: false
5328+
notify_on_signatures:
5329+
type: boolean
5330+
example: false
5331+
description: |
5332+
**true** - The document creator will receive an email notification whenever a signer signs the document.
5333+
5334+
**false** - The document creator will not receive an email notification whenever a signer signs the document.
5335+
5336+
Note: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on 'send_email' parameter.
5337+
pen_colors:
5338+
type: array
5339+
items:
5340+
type: string
5341+
example: ["blue", "red", "black"]
52735342
prefill:
52745343
$ref: '#/components/schemas/prefill'
52755344
inline_response_200_1:
@@ -5418,7 +5487,21 @@ components:
54185487
**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.
54195488
54205489
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.
5421-
example: false
5490+
example: false
5491+
notify_on_signatures:
5492+
type: boolean
5493+
example: false
5494+
description: |
5495+
**true** - The document creator will receive an email notification whenever a signer signs the document.
5496+
5497+
**false** - The document creator will not receive an email notification whenever a signer signs the document.
5498+
5499+
Note: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on 'send_email' parameter.
5500+
pen_colors:
5501+
type: array
5502+
items:
5503+
type: string
5504+
example: ["blue", "red", "black"]
54225505
prefill:
54235506
type: object
54245507
properties:
@@ -5511,6 +5594,20 @@ components:
55115594
type: number
55125595
description: "Number of days between reminders. This is only applicable when auto_reminder is set to true."
55135596
example: 5
5597+
notify_on_signatures:
5598+
type: boolean
5599+
example: false
5600+
description: |
5601+
**true** - The document creator will receive an email notification whenever a signer signs the document.
5602+
5603+
**false** - The document creator will not receive an email notification whenever a signer signs the document.
5604+
5605+
Note: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on 'send_email' parameter.
5606+
pen_colors:
5607+
type: array
5608+
items:
5609+
type: string
5610+
example: ["blue", "red", "black"]
55145611
inline_response_200_3:
55155612
type: object
55165613
properties:
@@ -5618,7 +5715,21 @@ components:
56185715
**false** - If you choose not to merge, the completion certificate will be provided as a separate signed PDF file along with the signed document.
56195716
56205717
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.
5621-
example: false
5718+
example: false
5719+
notify_on_signatures:
5720+
type: boolean
5721+
example: false
5722+
description: |
5723+
**true** - The document creator will receive an email notification whenever a signer signs the document.
5724+
5725+
**false** - The document creator will not receive an email notification whenever a signer signs the document.
5726+
5727+
Note: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on 'send_email' parameter.
5728+
pen_colors:
5729+
type: array
5730+
items:
5731+
type: string
5732+
example: ["blue", "red", "black"]
56225733
prefill:
56235734
$ref: '#/components/schemas/prefill'
56245735
inline_response_draft_200:
@@ -5703,7 +5814,21 @@ components:
57035814
remind_once_in_every:
57045815
type: number
57055816
description: "Number of days between reminders. This is only applicable when auto_reminder is set to true."
5706-
example: 5
5817+
example: 5
5818+
notify_on_signatures:
5819+
type: boolean
5820+
example: false
5821+
description: |
5822+
**true** - The document creator will receive an email notification whenever a signer signs the document.
5823+
5824+
**false** - The document creator will not receive an email notification whenever a signer signs the document.
5825+
5826+
Note: Regardless of this setting, a completion email with the signed document and completion certificate attached is depend on 'send_email' parameter.
5827+
pen_colors:
5828+
type: array
5829+
items:
5830+
type: string
5831+
example: ["blue", "red", "black"]
57075832
inline_response_404_7:
57085833
type: object
57095834
properties:

0 commit comments

Comments
 (0)