Skip to content

Commit adf3094

Browse files
Merge branch 'main' of github-hellosign:hellosign/hellosign-openapi into merge-main-to-oas-release
# Conflicts: # openapi-sdk.yaml
2 parents 92c9133 + 34f55f1 commit adf3094

46 files changed

Lines changed: 11 additions & 4762 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

openapi-raw.yaml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7286,7 +7286,9 @@ paths:
72867286
seo:
72877287
title: '_t__TemplateUpdate::SEO::TITLE'
72887288
description: '_t__TemplateUpdate::SEO::DESCRIPTION'
7289-
x-hideOn: doc
7289+
x-hideOn:
7290+
- doc
7291+
- sdk
72907292
'/template/update_files/{template_id}':
72917293
post:
72927294
tags:
@@ -10430,6 +10432,9 @@ components:
1043010432
- sdk
1043110433
- doc
1043210434
type: object
10435+
x-hideOn:
10436+
- sdk
10437+
- doc
1043310438
TemplateUpdateFilesRequest:
1043410439
properties:
1043510440
client_id:
@@ -13387,6 +13392,9 @@ components:
1338713392
summary: 'Default Example'
1338813393
value:
1338913394
$ref: examples/json/TemplateUpdateRequest.json
13395+
x-hideOn:
13396+
- sdk
13397+
- doc
1339013398
TemplateUpdateFilesRequest:
1339113399
summary: 'Default Example'
1339213400
value:

openapi-sdk.yaml

Lines changed: 0 additions & 142 deletions
Original file line numberDiff line numberDiff line change
@@ -7250,120 +7250,6 @@ paths:
72507250
seo:
72517251
title: 'Remove User from Template | REST API | Dropbox Sign for Developers'
72527252
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.'
7253-
'/template/update/{template_id}':
7254-
post:
7255-
tags:
7256-
- Template
7257-
summary: 'Update Template'
7258-
description: 'Update 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.'
7259-
operationId: templateUpdate
7260-
parameters:
7261-
-
7262-
name: template_id
7263-
in: path
7264-
description: 'The ID of the template to update.'
7265-
required: true
7266-
schema:
7267-
type: string
7268-
example: f57db65d3f933b5316d398057a36176831451a35
7269-
requestBody:
7270-
required: true
7271-
content:
7272-
application/json:
7273-
schema:
7274-
$ref: '#/components/schemas/TemplateUpdateRequest'
7275-
examples:
7276-
example:
7277-
$ref: '#/components/examples/TemplateUpdateRequest'
7278-
multipart/form-data:
7279-
schema:
7280-
$ref: '#/components/schemas/TemplateUpdateRequest'
7281-
responses:
7282-
'200':
7283-
description: 'successful operation'
7284-
headers:
7285-
X-RateLimit-Limit:
7286-
$ref: '#/components/headers/X-RateLimit-Limit'
7287-
X-RateLimit-Remaining:
7288-
$ref: '#/components/headers/X-RateLimit-Remaining'
7289-
X-Ratelimit-Reset:
7290-
$ref: '#/components/headers/X-Ratelimit-Reset'
7291-
content:
7292-
application/json:
7293-
schema:
7294-
$ref: '#/components/schemas/TemplateGetResponse'
7295-
examples:
7296-
example:
7297-
$ref: '#/components/examples/TemplateGetResponse'
7298-
'4XX':
7299-
description: failed_operation
7300-
content:
7301-
application/json:
7302-
schema:
7303-
$ref: '#/components/schemas/ErrorResponse'
7304-
examples:
7305-
400_example:
7306-
$ref: '#/components/examples/Error400Response'
7307-
401_example:
7308-
$ref: '#/components/examples/Error401Response'
7309-
402_example:
7310-
$ref: '#/components/examples/Error402Response'
7311-
403_example:
7312-
$ref: '#/components/examples/Error403Response'
7313-
429_example:
7314-
$ref: '#/components/examples/Error429Response'
7315-
404_example:
7316-
$ref: '#/components/examples/Error404Response'
7317-
409_example:
7318-
$ref: '#/components/examples/Error409Response'
7319-
4XX_example:
7320-
$ref: '#/components/examples/Error4XXResponse'
7321-
security:
7322-
-
7323-
api_key: []
7324-
-
7325-
oauth2:
7326-
- template_access
7327-
x-codeSamples:
7328-
-
7329-
lang: PHP
7330-
label: PHP
7331-
source:
7332-
$ref: examples/TemplateUpdateExample.php
7333-
-
7334-
lang: 'C#'
7335-
label: 'C#'
7336-
source:
7337-
$ref: examples/TemplateUpdateExample.cs
7338-
-
7339-
lang: TypeScript
7340-
label: TypeScript
7341-
source:
7342-
$ref: examples/TemplateUpdateExample.ts
7343-
-
7344-
lang: Java
7345-
label: Java
7346-
source:
7347-
$ref: examples/TemplateUpdateExample.java
7348-
-
7349-
lang: Ruby
7350-
label: Ruby
7351-
source:
7352-
$ref: examples/TemplateUpdateExample.rb
7353-
-
7354-
lang: Python
7355-
label: Python
7356-
source:
7357-
$ref: examples/TemplateUpdateExample.py
7358-
-
7359-
lang: cURL
7360-
label: cURL
7361-
source:
7362-
$ref: examples/TemplateUpdateExample.sh
7363-
x-meta:
7364-
seo:
7365-
title: 'Update Template | REST API | Dropbox Sign for Developers'
7366-
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.'
73677253
'/template/update_files/{template_id}':
73687254
post:
73697255
tags:
@@ -10933,30 +10819,6 @@ components:
1093310819
type: string
1093410820
format: email
1093510821
type: object
10936-
TemplateUpdateRequest:
10937-
properties:
10938-
cc_roles:
10939-
description: 'The CC roles that must be assigned when using the template to send a signature request.'
10940-
type: array
10941-
items:
10942-
type: string
10943-
title:
10944-
description: 'The title you want to assign to the SignatureRequest.'
10945-
type: string
10946-
subject:
10947-
description: 'The new default template email subject.'
10948-
type: string
10949-
maxLength: 200
10950-
message:
10951-
description: 'The new default template email message.'
10952-
type: string
10953-
maxLength: 5000
10954-
form_fields:
10955-
description: 'A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field.'
10956-
type: array
10957-
items:
10958-
$ref: '#/components/schemas/SubUpdateFormField'
10959-
type: object
1096010822
TemplateUpdateFilesRequest:
1096110823
properties:
1096210824
client_id:
@@ -14154,10 +14016,6 @@ components:
1415414016
summary: 'Default Example'
1415514017
value:
1415614018
$ref: examples/json/TemplateRemoveUserRequest.json
14157-
TemplateUpdateRequest:
14158-
summary: 'Default Example'
14159-
value:
14160-
$ref: examples/json/TemplateUpdateRequest.json
1416114019
TemplateUpdateFilesRequest:
1416214020
summary: 'Default Example'
1416314021
value:

openapi.yaml

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10799,30 +10799,6 @@ components:
1079910799
type: string
1080010800
format: email
1080110801
type: object
10802-
TemplateUpdateRequest:
10803-
properties:
10804-
cc_roles:
10805-
description: 'The CC roles that must be assigned when using the template to send a signature request.'
10806-
type: array
10807-
items:
10808-
type: string
10809-
title:
10810-
description: 'The title you want to assign to the SignatureRequest.'
10811-
type: string
10812-
subject:
10813-
description: 'The new default template email subject.'
10814-
type: string
10815-
maxLength: 200
10816-
message:
10817-
description: 'The new default template email message.'
10818-
type: string
10819-
maxLength: 5000
10820-
form_fields:
10821-
description: 'A list of document form fields to update. The endpoint will not create or remove any fields. Every field must be identified by `api_id`, and the only supported change is renaming the field.'
10822-
type: array
10823-
items:
10824-
$ref: '#/components/schemas/SubUpdateFormField'
10825-
type: object
1082610802
TemplateUpdateFilesRequest:
1082710803
properties:
1082810804
client_id:
@@ -14026,10 +14002,6 @@ components:
1402614002
summary: 'Default Example'
1402714003
value:
1402814004
$ref: examples/json/TemplateRemoveUserRequest.json
14029-
TemplateUpdateRequest:
14030-
summary: 'Default Example'
14031-
value:
14032-
$ref: examples/json/TemplateUpdateRequest.json
1403314005
TemplateUpdateFilesRequest:
1403414006
summary: 'Default Example'
1403514007
value:

sdks/dotnet/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,6 @@ Class | Method | HTTP request | Description
199199
*TemplateApi* | [**TemplateGet**](docs/TemplateApi.md#templateget) | **GET** /template/{template_id} | Get Template
200200
*TemplateApi* | [**TemplateList**](docs/TemplateApi.md#templatelist) | **GET** /template/list | List Templates
201201
*TemplateApi* | [**TemplateRemoveUser**](docs/TemplateApi.md#templateremoveuser) | **POST** /template/remove_user/{template_id} | Remove User from Template
202-
*TemplateApi* | [**TemplateUpdate**](docs/TemplateApi.md#templateupdate) | **POST** /template/update/{template_id} | Update Template
203202
*TemplateApi* | [**TemplateUpdateFiles**](docs/TemplateApi.md#templateupdatefiles) | **POST** /template/update_files/{template_id} | Update Template Files
204203
*UnclaimedDraftApi* | [**UnclaimedDraftCreate**](docs/UnclaimedDraftApi.md#unclaimeddraftcreate) | **POST** /unclaimed_draft/create | Create Unclaimed Draft
205204
*UnclaimedDraftApi* | [**UnclaimedDraftCreateEmbedded**](docs/UnclaimedDraftApi.md#unclaimeddraftcreateembedded) | **POST** /unclaimed_draft/create_embedded | Create Embedded Unclaimed Draft
@@ -396,7 +395,6 @@ Class | Method | HTTP request | Description
396395
- [Model.TemplateUpdateFilesRequest](docs/TemplateUpdateFilesRequest.md)
397396
- [Model.TemplateUpdateFilesResponse](docs/TemplateUpdateFilesResponse.md)
398397
- [Model.TemplateUpdateFilesResponseTemplate](docs/TemplateUpdateFilesResponseTemplate.md)
399-
- [Model.TemplateUpdateRequest](docs/TemplateUpdateRequest.md)
400398
- [Model.UnclaimedDraftCreateEmbeddedRequest](docs/UnclaimedDraftCreateEmbeddedRequest.md)
401399
- [Model.UnclaimedDraftCreateEmbeddedWithTemplateRequest](docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md)
402400
- [Model.UnclaimedDraftCreateRequest](docs/UnclaimedDraftCreateRequest.md)

sdks/dotnet/docs/TemplateApi.md

Lines changed: 0 additions & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ All URIs are relative to *https://api.hellosign.com/v3*
1414
| [**TemplateGet**](TemplateApi.md#templateget) | **GET** /template/{template_id} | Get Template |
1515
| [**TemplateList**](TemplateApi.md#templatelist) | **GET** /template/list | List Templates |
1616
| [**TemplateRemoveUser**](TemplateApi.md#templateremoveuser) | **POST** /template/remove_user/{template_id} | Remove User from Template |
17-
| [**TemplateUpdate**](TemplateApi.md#templateupdate) | **POST** /template/update/{template_id} | Update Template |
1817
| [**TemplateUpdateFiles**](TemplateApi.md#templateupdatefiles) | **POST** /template/update_files/{template_id} | Update Template Files |
1918

2019
<a id="templateadduser"></a>
@@ -1136,131 +1135,6 @@ catch (ApiException e)
11361135
- **Accept**: application/json
11371136

11381137

1139-
### HTTP response details
1140-
| Status code | Description | Response headers |
1141-
|-------------|-------------|------------------|
1142-
| **200** | successful operation | * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> |
1143-
| **4XX** | failed_operation | - |
1144-
1145-
[[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)
1146-
1147-
<a id="templateupdate"></a>
1148-
# **TemplateUpdate**
1149-
> TemplateGetResponse TemplateUpdate (string templateId, TemplateUpdateRequest templateUpdateRequest)
1150-
1151-
Update Template
1152-
1153-
Update 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.
1154-
1155-
### Example
1156-
```csharp
1157-
using System;
1158-
using System.Collections.Generic;
1159-
using System.IO;
1160-
using System.Text.Json;
1161-
1162-
using Dropbox.Sign.Api;
1163-
using Dropbox.Sign.Client;
1164-
using Dropbox.Sign.Model;
1165-
1166-
namespace Dropbox.SignSandbox;
1167-
1168-
public class TemplateUpdateExample
1169-
{
1170-
public static void Run()
1171-
{
1172-
var config = new Configuration();
1173-
config.Username = "YOUR_API_KEY";
1174-
// config.AccessToken = "YOUR_ACCESS_TOKEN";
1175-
1176-
var formFields1 = new SubUpdateFormField(
1177-
apiId: "uniqueIdHere_1",
1178-
name: "New name 1"
1179-
);
1180-
1181-
var formFields2 = new SubUpdateFormField(
1182-
apiId: "uniqueIdHere_2",
1183-
name: "New name 2"
1184-
);
1185-
1186-
var formFields = new List<SubUpdateFormField>
1187-
{
1188-
formFields1,
1189-
formFields2,
1190-
};
1191-
1192-
var templateUpdateRequest = new TemplateUpdateRequest(
1193-
title: "Test Title",
1194-
subject: "Test Subject",
1195-
message: "Test Message",
1196-
ccRoles: [
1197-
"CC Role 1",
1198-
"CC Role 2",
1199-
],
1200-
formFields: formFields
1201-
);
1202-
1203-
try
1204-
{
1205-
var response = new TemplateApi(config).TemplateUpdate(
1206-
templateId: "f57db65d3f933b5316d398057a36176831451a35",
1207-
templateUpdateRequest: templateUpdateRequest
1208-
);
1209-
1210-
Console.WriteLine(response);
1211-
}
1212-
catch (ApiException e)
1213-
{
1214-
Console.WriteLine("Exception when calling TemplateApi#TemplateUpdate: " + e.Message);
1215-
Console.WriteLine("Status Code: " + e.ErrorCode);
1216-
Console.WriteLine(e.StackTrace);
1217-
}
1218-
}
1219-
}
1220-
1221-
```
1222-
1223-
#### Using the TemplateUpdateWithHttpInfo variant
1224-
This returns an ApiResponse object which contains the response data, status code and headers.
1225-
1226-
```csharp
1227-
try
1228-
{
1229-
// Update Template
1230-
ApiResponse<TemplateGetResponse> response = apiInstance.TemplateUpdateWithHttpInfo(templateId, templateUpdateRequest);
1231-
Debug.Write("Status Code: " + response.StatusCode);
1232-
Debug.Write("Response Headers: " + response.Headers);
1233-
Debug.Write("Response Body: " + response.Data);
1234-
}
1235-
catch (ApiException e)
1236-
{
1237-
Debug.Print("Exception when calling TemplateApi.TemplateUpdateWithHttpInfo: " + e.Message);
1238-
Debug.Print("Status Code: " + e.ErrorCode);
1239-
Debug.Print(e.StackTrace);
1240-
}
1241-
```
1242-
1243-
### Parameters
1244-
1245-
| Name | Type | Description | Notes |
1246-
|------|------|-------------|-------|
1247-
| **templateId** | **string** | The ID of the template to update. | |
1248-
| **templateUpdateRequest** | [**TemplateUpdateRequest**](TemplateUpdateRequest.md) | | |
1249-
1250-
### Return type
1251-
1252-
[**TemplateGetResponse**](TemplateGetResponse.md)
1253-
1254-
### Authorization
1255-
1256-
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
1257-
1258-
### HTTP request headers
1259-
1260-
- **Content-Type**: application/json, multipart/form-data
1261-
- **Accept**: application/json
1262-
1263-
12641138
### HTTP response details
12651139
| Status code | Description | Response headers |
12661140
|-------------|-------------|------------------|

0 commit comments

Comments
 (0)