Skip to content

Commit ee248cd

Browse files
committed
Add more detailed description of template create
1 parent 47f6d8d commit ee248cd

File tree

17 files changed

+78
-29
lines changed

17 files changed

+78
-29
lines changed

openapi-sdk.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6260,7 +6260,12 @@ paths:
62606260
tags:
62616261
- Template
62626262
summary: 'Create Template'
6263-
description: 'Creates a template that can then be used.'
6263+
description: |-
6264+
Creates a template that can be used in future signature requests.
6265+
6266+
If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/).
6267+
6268+
Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
62646269
operationId: templateCreate
62656270
requestBody:
62666271
required: true

openapi.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6260,7 +6260,12 @@ paths:
62606260
tags:
62616261
- Template
62626262
summary: 'Create Template'
6263-
description: 'Creates a template that can then be used.'
6263+
description: |-
6264+
Creates a template that can be used in future signature requests.
6265+
6266+
If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/).
6267+
6268+
Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
62646269
operationId: templateCreate
62656270
requestBody:
62666271
required: true

sdks/dotnet/docs/TemplateApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ catch (ApiException e)
125125
126126
Create Template
127127

128-
Creates a template that can then be used.
128+
Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
129129

130130
### Example
131131
```csharp

sdks/dotnet/src/Dropbox.Sign/Api/TemplateApi.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public interface ITemplateApiSync : IApiAccessor
5656
/// Create Template
5757
/// </summary>
5858
/// <remarks>
59-
/// Creates a template that can then be used.
59+
/// Creates a template that can be used in future signature requests. If &#x60;client_id&#x60; is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new &#x60;edit_url&#x60; with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A &#x60;template_created&#x60; event indicates the template is ready to use, while a &#x60;template_error&#x60; event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
6060
/// </remarks>
6161
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
6262
/// <param name="templateCreateRequest"></param>
@@ -68,7 +68,7 @@ public interface ITemplateApiSync : IApiAccessor
6868
/// Create Template
6969
/// </summary>
7070
/// <remarks>
71-
/// Creates a template that can then be used.
71+
/// Creates a template that can be used in future signature requests. If &#x60;client_id&#x60; is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new &#x60;edit_url&#x60; with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A &#x60;template_created&#x60; event indicates the template is ready to use, while a &#x60;template_error&#x60; event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
7272
/// </remarks>
7373
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
7474
/// <param name="templateCreateRequest"></param>
@@ -361,7 +361,7 @@ public interface ITemplateApiAsync : IApiAccessor
361361
/// Create Template
362362
/// </summary>
363363
/// <remarks>
364-
/// Creates a template that can then be used.
364+
/// Creates a template that can be used in future signature requests. If &#x60;client_id&#x60; is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new &#x60;edit_url&#x60; with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A &#x60;template_created&#x60; event indicates the template is ready to use, while a &#x60;template_error&#x60; event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
365365
/// </remarks>
366366
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
367367
/// <param name="templateCreateRequest"></param>
@@ -374,7 +374,7 @@ public interface ITemplateApiAsync : IApiAccessor
374374
/// Create Template
375375
/// </summary>
376376
/// <remarks>
377-
/// Creates a template that can then be used.
377+
/// Creates a template that can be used in future signature requests. If &#x60;client_id&#x60; is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new &#x60;edit_url&#x60; with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A &#x60;template_created&#x60; event indicates the template is ready to use, while a &#x60;template_error&#x60; event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
378378
/// </remarks>
379379
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
380380
/// <param name="templateCreateRequest"></param>
@@ -971,7 +971,7 @@ public Dropbox.Sign.Client.ApiResponse<TemplateGetResponse> TemplateAddUserWithH
971971
}
972972

973973
/// <summary>
974-
/// Create Template Creates a template that can then be used.
974+
/// Create Template Creates a template that can be used in future signature requests. If &#x60;client_id&#x60; is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new &#x60;edit_url&#x60; with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A &#x60;template_created&#x60; event indicates the template is ready to use, while a &#x60;template_error&#x60; event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
975975
/// </summary>
976976
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
977977
/// <param name="templateCreateRequest"></param>
@@ -984,7 +984,7 @@ public TemplateCreateResponse TemplateCreate(TemplateCreateRequest templateCreat
984984
}
985985

986986
/// <summary>
987-
/// Create Template Creates a template that can then be used.
987+
/// Create Template Creates a template that can be used in future signature requests. If &#x60;client_id&#x60; is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new &#x60;edit_url&#x60; with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A &#x60;template_created&#x60; event indicates the template is ready to use, while a &#x60;template_error&#x60; event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
988988
/// </summary>
989989
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
990990
/// <param name="templateCreateRequest"></param>
@@ -1061,7 +1061,7 @@ public Dropbox.Sign.Client.ApiResponse<TemplateCreateResponse> TemplateCreateWit
10611061
}
10621062

10631063
/// <summary>
1064-
/// Create Template Creates a template that can then be used.
1064+
/// Create Template Creates a template that can be used in future signature requests. If &#x60;client_id&#x60; is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new &#x60;edit_url&#x60; with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A &#x60;template_created&#x60; event indicates the template is ready to use, while a &#x60;template_error&#x60; event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
10651065
/// </summary>
10661066
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
10671067
/// <param name="templateCreateRequest"></param>
@@ -1075,7 +1075,7 @@ public Dropbox.Sign.Client.ApiResponse<TemplateCreateResponse> TemplateCreateWit
10751075
}
10761076

10771077
/// <summary>
1078-
/// Create Template Creates a template that can then be used.
1078+
/// Create Template Creates a template that can be used in future signature requests. If &#x60;client_id&#x60; is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new &#x60;edit_url&#x60; with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A &#x60;template_created&#x60; event indicates the template is ready to use, while a &#x60;template_error&#x60; event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
10791079
/// </summary>
10801080
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
10811081
/// <param name="templateCreateRequest"></param>

sdks/java-v1/docs/TemplateApi.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,11 @@ public class TemplateAddUserExample
112112
113113
Create Template
114114

115-
Creates a template that can then be used.
115+
Creates a template that can be used in future signature requests.
116+
117+
If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/).
118+
119+
Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
116120

117121
### Example
118122

sdks/java-v1/src/main/java/com/dropbox/sign/api/TemplateApi.java

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,18 @@ public ApiResponse<TemplateGetResponse> templateAddUserWithHttpInfo(
145145
}
146146

147147
/**
148-
* Create Template Creates a template that can then be used.
148+
* Create Template Creates a template that can be used in future signature requests. If
149+
* &#x60;client_id&#x60; is provided, the template will be created as an embedded template.
150+
* Embedded templates can be used for embedded signature requests and can be edited later by
151+
* generating a new &#x60;edit_url&#x60; with
152+
* [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template
153+
* creation may complete asynchronously after the initial request is accepted. It is recommended
154+
* that a callback be implemented to listen for the callback event. A
155+
* &#x60;template_created&#x60; event indicates the template is ready to use, while a
156+
* &#x60;template_error&#x60; event indicates there was a problem while creating the template.
157+
* If a callback handler has been configured and the event has not been received within 60
158+
* minutes of making the call, check the status of the request in the API dashboard and retry
159+
* the request if necessary.
149160
*
150161
* @param templateCreateRequest (required)
151162
* @return TemplateCreateResponse
@@ -164,7 +175,18 @@ public TemplateCreateResponse templateCreate(TemplateCreateRequest templateCreat
164175
}
165176

166177
/**
167-
* Create Template Creates a template that can then be used.
178+
* Create Template Creates a template that can be used in future signature requests. If
179+
* &#x60;client_id&#x60; is provided, the template will be created as an embedded template.
180+
* Embedded templates can be used for embedded signature requests and can be edited later by
181+
* generating a new &#x60;edit_url&#x60; with
182+
* [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template
183+
* creation may complete asynchronously after the initial request is accepted. It is recommended
184+
* that a callback be implemented to listen for the callback event. A
185+
* &#x60;template_created&#x60; event indicates the template is ready to use, while a
186+
* &#x60;template_error&#x60; event indicates there was a problem while creating the template.
187+
* If a callback handler has been configured and the event has not been received within 60
188+
* minutes of making the call, check the status of the request in the API dashboard and retry
189+
* the request if necessary.
168190
*
169191
* @param templateCreateRequest (required)
170192
* @return ApiResponse&lt;TemplateCreateResponse&gt;

sdks/java-v2/docs/TemplateApi.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,11 @@ public class TemplateAddUserExample
112112
113113
Create Template
114114

115-
Creates a template that can then be used.
115+
Creates a template that can be used in future signature requests.
116+
117+
If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/).
118+
119+
Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
116120

117121
### Example
118122

0 commit comments

Comments
 (0)