Skip to content

Commit d0a716e

Browse files
mchatlas-hellosignmchatlas-hellosign
committed
Added base docs and translations
1 parent a937871 commit d0a716e

6 files changed

Lines changed: 447 additions & 24 deletions

File tree

‎examples/json/TemplateUpdateRequest.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"allow_form_view": false,
3+
"title": "Test Title",
4+
"subject": "Test Subject",
5+
"message": "Test Message",
6+
"cc_roles": ["one", "two"]
7+
}

‎openapi-raw.yaml‎

Lines changed: 140 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7172,6 +7172,120 @@ paths:
71727172
seo:
71737173
title: '_t__TemplateRemoveUser::SEO::TITLE'
71747174
description: '_t__TemplateRemoveUser::SEO::DESCRIPTION'
7175+
'/template/update/{template_id}':
7176+
post:
7177+
tags:
7178+
- Template
7179+
summary: '_t__TemplateUpdate::SUMMARY'
7180+
description: '_t__TemplateUpdate::DESCRIPTION'
7181+
operationId: templateUpdate
7182+
parameters:
7183+
-
7184+
name: template_id
7185+
in: path
7186+
description: '_t__TemplateUpdate::TEMPLATE_ID'
7187+
required: true
7188+
schema:
7189+
type: string
7190+
example: f57db65d3f933b5316d398057a36176831451a35
7191+
requestBody:
7192+
required: true
7193+
content:
7194+
application/json:
7195+
schema:
7196+
$ref: '#/components/schemas/TemplateUpdateRequest'
7197+
examples:
7198+
example:
7199+
$ref: '#/components/examples/TemplateUpdateRequest'
7200+
multipart/form-data:
7201+
schema:
7202+
$ref: '#/components/schemas/TemplateUpdateRequest'
7203+
responses:
7204+
'200':
7205+
description: 'successful operation'
7206+
headers:
7207+
X-RateLimit-Limit:
7208+
$ref: '#/components/headers/X-RateLimit-Limit'
7209+
X-RateLimit-Remaining:
7210+
$ref: '#/components/headers/X-RateLimit-Remaining'
7211+
X-Ratelimit-Reset:
7212+
$ref: '#/components/headers/X-Ratelimit-Reset'
7213+
content:
7214+
application/json:
7215+
schema:
7216+
$ref: '#/components/schemas/TemplateGetResponse'
7217+
examples:
7218+
example:
7219+
$ref: '#/components/examples/TemplateGetResponse'
7220+
4XX:
7221+
description: failed_operation
7222+
content:
7223+
application/json:
7224+
schema:
7225+
$ref: '#/components/schemas/ErrorResponse'
7226+
examples:
7227+
400_example:
7228+
$ref: '#/components/examples/Error400Response'
7229+
401_example:
7230+
$ref: '#/components/examples/Error401Response'
7231+
402_example:
7232+
$ref: '#/components/examples/Error402Response'
7233+
403_example:
7234+
$ref: '#/components/examples/Error403Response'
7235+
429_example:
7236+
$ref: '#/components/examples/Error429Response'
7237+
404_example:
7238+
$ref: '#/components/examples/Error404Response'
7239+
409_example:
7240+
$ref: '#/components/examples/Error409Response'
7241+
4XX_example:
7242+
$ref: '#/components/examples/Error4XXResponse'
7243+
security:
7244+
-
7245+
api_key: []
7246+
-
7247+
oauth2:
7248+
- template_access
7249+
x-codeSamples:
7250+
-
7251+
lang: PHP
7252+
label: PHP
7253+
source:
7254+
$ref: examples/TemplateUpdateExample.php
7255+
-
7256+
lang: 'C#'
7257+
label: 'C#'
7258+
source:
7259+
$ref: examples/TemplateUpdateExample.cs
7260+
-
7261+
lang: TypeScript
7262+
label: TypeScript
7263+
source:
7264+
$ref: examples/TemplateUpdateExample.ts
7265+
-
7266+
lang: Java
7267+
label: Java
7268+
source:
7269+
$ref: examples/TemplateUpdateExample.java
7270+
-
7271+
lang: Ruby
7272+
label: Ruby
7273+
source:
7274+
$ref: examples/TemplateUpdateExample.rb
7275+
-
7276+
lang: Python
7277+
label: Python
7278+
source:
7279+
$ref: examples/TemplateUpdateExample.py
7280+
-
7281+
lang: cURL
7282+
label: cURL
7283+
source:
7284+
$ref: examples/TemplateUpdateExample.sh
7285+
x-meta:
7286+
seo:
7287+
title: '_t__TemplateUpdate::SEO::TITLE'
7288+
description: '_t__TemplateUpdate::SEO::DESCRIPTION'
71757289
'/template/update_files/{template_id}':
71767290
post:
71777291
tags:
@@ -10189,6 +10303,28 @@ components:
1018910303
type: string
1019010304
format: email
1019110305
type: object
10306+
TemplateUpdateRequest:
10307+
properties:
10308+
cc_roles:
10309+
description: '_t__TemplateUpdate::CC_ROLES'
10310+
type: array
10311+
items:
10312+
type: string
10313+
allow_form_view:
10314+
description: '_t__TemplateUpdate::ALLOW_FORM_VIEW'
10315+
type: boolean
10316+
title:
10317+
description: '_t__TemplateUpdate::TITLE'
10318+
type: string
10319+
subject:
10320+
description: '_t__TemplateUpdate::SUBJECT'
10321+
type: string
10322+
maxLength: 200
10323+
message:
10324+
description: '_t__TemplateUpdate::MESSAGE'
10325+
type: string
10326+
maxLength: 5000
10327+
type: object
1019210328
TemplateUpdateFilesRequest:
1019310329
properties:
1019410330
client_id:
@@ -12767,14 +12903,6 @@ components:
1276712903
$ref: '#/components/schemas/WarningResponse'
1276812904
type: object
1276912905
x-internal-class: true
12770-
TemplateEditResponse:
12771-
required:
12772-
- template_id
12773-
properties:
12774-
template_id:
12775-
description: '_t__TemplateResponse::TEMPLATE_ID'
12776-
type: string
12777-
type: object
1277812906
TemplateGetResponse:
1277912907
required:
1278012908
- template
@@ -13102,6 +13230,10 @@ components:
1310213230
summary: 'Default Example'
1310313231
value:
1310413232
$ref: examples/json/TemplateRemoveUserRequest.json
13233+
TemplateUpdateRequest:
13234+
summary: 'Default Example'
13235+
value:
13236+
$ref: examples/json/TemplateUpdateRequest.json
1310513237
TemplateUpdateFilesRequest:
1310613238
summary: 'Default Example'
1310713239
value:

‎openapi-sdk.yaml‎

Lines changed: 140 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7245,6 +7245,120 @@ paths:
72457245
seo:
72467246
title: 'Remove User from Template | REST API | Dropbox Sign for Developers'
72477247
description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.'
7248+
'/template/update/{template_id}':
7249+
post:
7250+
tags:
7251+
- Template
7252+
summary: 'Edit Template'
7253+
description: 'Edit template fields. Every field is optional and the endpoint will only change whatever is provided. The fields not included in the request payload will remain unchanged.'
7254+
operationId: templateUpdate
7255+
parameters:
7256+
-
7257+
name: template_id
7258+
in: path
7259+
description: 'The ID of the template to update.'
7260+
required: true
7261+
schema:
7262+
type: string
7263+
example: f57db65d3f933b5316d398057a36176831451a35
7264+
requestBody:
7265+
required: true
7266+
content:
7267+
application/json:
7268+
schema:
7269+
$ref: '#/components/schemas/TemplateUpdateRequest'
7270+
examples:
7271+
example:
7272+
$ref: '#/components/examples/TemplateUpdateRequest'
7273+
multipart/form-data:
7274+
schema:
7275+
$ref: '#/components/schemas/TemplateUpdateRequest'
7276+
responses:
7277+
'200':
7278+
description: 'successful operation'
7279+
headers:
7280+
X-RateLimit-Limit:
7281+
$ref: '#/components/headers/X-RateLimit-Limit'
7282+
X-RateLimit-Remaining:
7283+
$ref: '#/components/headers/X-RateLimit-Remaining'
7284+
X-Ratelimit-Reset:
7285+
$ref: '#/components/headers/X-Ratelimit-Reset'
7286+
content:
7287+
application/json:
7288+
schema:
7289+
$ref: '#/components/schemas/TemplateGetResponse'
7290+
examples:
7291+
example:
7292+
$ref: '#/components/examples/TemplateGetResponse'
7293+
'4XX':
7294+
description: failed_operation
7295+
content:
7296+
application/json:
7297+
schema:
7298+
$ref: '#/components/schemas/ErrorResponse'
7299+
examples:
7300+
400_example:
7301+
$ref: '#/components/examples/Error400Response'
7302+
401_example:
7303+
$ref: '#/components/examples/Error401Response'
7304+
402_example:
7305+
$ref: '#/components/examples/Error402Response'
7306+
403_example:
7307+
$ref: '#/components/examples/Error403Response'
7308+
429_example:
7309+
$ref: '#/components/examples/Error429Response'
7310+
404_example:
7311+
$ref: '#/components/examples/Error404Response'
7312+
409_example:
7313+
$ref: '#/components/examples/Error409Response'
7314+
4XX_example:
7315+
$ref: '#/components/examples/Error4XXResponse'
7316+
security:
7317+
-
7318+
api_key: []
7319+
-
7320+
oauth2:
7321+
- template_access
7322+
x-codeSamples:
7323+
-
7324+
lang: PHP
7325+
label: PHP
7326+
source:
7327+
$ref: examples/TemplateUpdateExample.php
7328+
-
7329+
lang: 'C#'
7330+
label: 'C#'
7331+
source:
7332+
$ref: examples/TemplateUpdateExample.cs
7333+
-
7334+
lang: TypeScript
7335+
label: TypeScript
7336+
source:
7337+
$ref: examples/TemplateUpdateExample.ts
7338+
-
7339+
lang: Java
7340+
label: Java
7341+
source:
7342+
$ref: examples/TemplateUpdateExample.java
7343+
-
7344+
lang: Ruby
7345+
label: Ruby
7346+
source:
7347+
$ref: examples/TemplateUpdateExample.rb
7348+
-
7349+
lang: Python
7350+
label: Python
7351+
source:
7352+
$ref: examples/TemplateUpdateExample.py
7353+
-
7354+
lang: cURL
7355+
label: cURL
7356+
source:
7357+
$ref: examples/TemplateUpdateExample.sh
7358+
x-meta:
7359+
seo:
7360+
title: 'Update Template | REST API | Dropbox Sign for Developers'
7361+
description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to update properties of an existing template, click here.'
72487362
'/template/update_files/{template_id}':
72497363
post:
72507364
tags:
@@ -10826,6 +10940,28 @@ components:
1082610940
type: string
1082710941
format: email
1082810942
type: object
10943+
TemplateUpdateRequest:
10944+
properties:
10945+
cc_roles:
10946+
description: 'The CC roles that must be assigned when using the template to send a signature request.'
10947+
type: array
10948+
items:
10949+
type: string
10950+
allow_form_view:
10951+
description: 'The CC roles that must be assigned when using the template to send a signature request. If set to `true` all the form fields on template document must have non-empty names.'
10952+
type: boolean
10953+
title:
10954+
description: 'The title you want to assign to the SignatureRequest.'
10955+
type: string
10956+
subject:
10957+
description: 'The new default template email subject.'
10958+
type: string
10959+
maxLength: 200
10960+
message:
10961+
description: 'The new default template email message.'
10962+
type: string
10963+
maxLength: 5000
10964+
type: object
1082910965
TemplateUpdateFilesRequest:
1083010966
properties:
1083110967
client_id:
@@ -13691,14 +13827,6 @@ components:
1369113827
$ref: '#/components/schemas/WarningResponse'
1369213828
type: object
1369313829
x-internal-class: true
13694-
TemplateEditResponse:
13695-
required:
13696-
- template_id
13697-
properties:
13698-
template_id:
13699-
description: 'The id of the Template.'
13700-
type: string
13701-
type: object
1370213830
TemplateGetResponse:
1370313831
required:
1370413832
- template
@@ -14026,6 +14154,10 @@ components:
1402614154
summary: 'Default Example'
1402714155
value:
1402814156
$ref: examples/json/TemplateRemoveUserRequest.json
14157+
TemplateUpdateRequest:
14158+
summary: 'Default Example'
14159+
value:
14160+
$ref: examples/json/TemplateUpdateRequest.json
1402914161
TemplateUpdateFilesRequest:
1403014162
summary: 'Default Example'
1403114163
value:

0 commit comments

Comments
 (0)