Skip to content

Added docs for template edit request #503

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mchatlas-hellosign wants to merge 1 commit into from
Closed

Added docs for template edit request #503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
7 changes: 7 additions & 0 deletions examples/json/TemplateEditRequest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"allow_form_view": false,
"title": "Test Title",
"subject": "Test Subject",
"message": "Test Message",
"cc_roles": ["one", "two"]
}
5 changes: 5 additions & 0 deletions examples/json/TemplateEditResponse.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"template": {
"template_id": "f57db65d3f933b5316d398057a36176831451a35"
}
}
325 changes: 264 additions & 61 deletions openapi-raw.yaml
View file
Open in desktop

Large diffs are not rendered by default.

325 changes: 264 additions & 61 deletions openapi-sdk.yaml
View file
Open in desktop

Large diffs are not rendered by default.

325 changes: 264 additions & 61 deletions openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions sdks/dotnet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@ Class | Method | HTTP request | Description
*TemplateApi* | [**TemplateCreate**](docs/TemplateApi.md#templatecreate) | **POST** /template/create | Create Template
*TemplateApi* | [**TemplateCreateEmbeddedDraft**](docs/TemplateApi.md#templatecreateembeddeddraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft
*TemplateApi* | [**TemplateDelete**](docs/TemplateApi.md#templatedelete) | **POST** /template/delete/{template_id} | Delete Template
*TemplateApi* | [**TemplateEdit**](docs/TemplateApi.md#templateedit) | **POST** /template/edit/{template_id} | _t__TemplateEdit::SUMMARY
*TemplateApi* | [**TemplateFiles**](docs/TemplateApi.md#templatefiles) | **GET** /template/files/{template_id} | Get Template Files
*TemplateApi* | [**TemplateFilesAsDataUri**](docs/TemplateApi.md#templatefilesasdatauri) | **GET** /template/files_as_data_uri/{template_id} | Get Template Files as Data Uri
*TemplateApi* | [**TemplateFilesAsFileUrl**](docs/TemplateApi.md#templatefilesasfileurl) | **GET** /template/files_as_file_url/{template_id} | Get Template Files as File Url
Expand Down Expand Up @@ -357,7 +358,9 @@ Class | Method | HTTP request | Description
- [Model.TemplateCreateRequest](docs/TemplateCreateRequest.md)
- [Model.TemplateCreateResponse](docs/TemplateCreateResponse.md)
- [Model.TemplateCreateResponseTemplate](docs/TemplateCreateResponseTemplate.md)
- [Model.TemplateEditRequest](docs/TemplateEditRequest.md)
- [Model.TemplateEditResponse](docs/TemplateEditResponse.md)
- [Model.TemplateEditResponseTemplate](docs/TemplateEditResponseTemplate.md)
- [Model.TemplateGetResponse](docs/TemplateGetResponse.md)
- [Model.TemplateListResponse](docs/TemplateListResponse.md)
- [Model.TemplateRemoveUserRequest](docs/TemplateRemoveUserRequest.md)
Expand Down
63 changes: 63 additions & 0 deletions sdks/dotnet/docs/TemplateApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
| [**TemplateCreate**](TemplateApi.md#templatecreate) | **POST** /template/create | Create Template |
| [**TemplateCreateEmbeddedDraft**](TemplateApi.md#templatecreateembeddeddraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft |
| [**TemplateDelete**](TemplateApi.md#templatedelete) | **POST** /template/delete/{template_id} | Delete Template |
| [**TemplateEdit**](TemplateApi.md#templateedit) | **POST** /template/edit/{template_id} | _t__TemplateEdit::SUMMARY |
| [**TemplateFiles**](TemplateApi.md#templatefiles) | **GET** /template/files/{template_id} | Get Template Files |
| [**TemplateFilesAsDataUri**](TemplateApi.md#templatefilesasdatauri) | **GET** /template/files_as_data_uri/{template_id} | Get Template Files as Data Uri |
| [**TemplateFilesAsFileUrl**](TemplateApi.md#templatefilesasfileurl) | **GET** /template/files_as_file_url/{template_id} | Get Template Files as File Url |
Expand Down Expand Up @@ -544,6 +545,68 @@ void (empty response body)
- **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | successful operation | * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> |
| **4XX** | failed_operation | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

<a id="templateedit"></a>
# **TemplateEdit**
> TemplateEditResponse TemplateEdit (string templateId, TemplateEditRequest templateEditRequest)

_t__TemplateEdit::SUMMARY

_t__TemplateEdit::DESCRIPTION

### Example
```csharp
REPLACE_ME_WITH_EXAMPLE_FOR__TemplateEdit_C#_CODE
```

#### Using the TemplateEditWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.

```csharp
try
{
// _t__TemplateEdit::SUMMARY
ApiResponse<TemplateEditResponse> response = apiInstance.TemplateEditWithHttpInfo(templateId, templateEditRequest);
Debug.Write("Status Code: " + response.StatusCode);
Debug.Write("Response Headers: " + response.Headers);
Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
Debug.Print("Exception when calling TemplateApi.TemplateEditWithHttpInfo: " + e.Message);
Debug.Print("Status Code: " + e.ErrorCode);
Debug.Print(e.StackTrace);
}
```

### Parameters

| Name | Type | Description | Notes |
|------|------|-------------|-------|
| **templateId** | **string** | _t__TemplateEdit::TEMPLATE_ID | |
| **templateEditRequest** | [**TemplateEditRequest**](TemplateEditRequest.md) | | |

### Return type

[**TemplateEditResponse**](TemplateEditResponse.md)

### Authorization

[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)

### HTTP request headers

- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
Expand Down
10 changes: 10 additions & 0 deletions sdks/dotnet/docs/TemplateEditRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Dropbox.Sign.Model.TemplateEditRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CcRoles** | **List&lt;string&gt;** | _t__TemplateEdit::CC_ROLES | [optional] **AllowFormView** | **bool** | _t__TemplateEdit::ALLOW_FORM_VIEW | [optional] **Title** | **string** | _t__TemplateEdit::TITLE | [optional] **Subject** | **string** | _t__TemplateEdit::SUBJECT | [optional] **Message** | **string** | _t__TemplateEdit::MESSAGE | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2 changes: 1 addition & 1 deletion sdks/dotnet/docs/TemplateEditResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TemplateId** | **string** | The id of the Template. |
**Template** | [**TemplateEditResponseTemplate**](TemplateEditResponseTemplate.md) | | [optional] **Warnings** | [**List&lt;WarningResponse&gt;**](WarningResponse.md) | A list of warnings. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11 changes: 11 additions & 0 deletions sdks/dotnet/docs/TemplateEditResponseTemplate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Dropbox.Sign.Model.TemplateEditResponseTemplate
_t__TemplateEditResponseTemplate::DESCRIPTION

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TemplateId** | **string** | The id of the Template. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Loading
Loading