Skip to content

Commit aec26cb

Browse files
jyoung-dbxjyoung-dbx
authored
Update fax file descriptions and fix typo (#461)
1 parent e187ac9 commit aec26cb

File tree

37 files changed

+98
-98
lines changed

37 files changed

+98
-98
lines changed

‎openapi-sdk.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1609,8 +1609,8 @@ paths:
16091609
get:
16101610
tags:
16111611
- Fax
1612-
summary: 'List Fax Files'
1613-
description: 'Returns list of fax files'
1612+
summary: 'Download Fax Files'
1613+
description: 'Downloads fax files'
16141614
operationId: faxFiles
16151615
parameters:
16161616
-
@@ -1812,7 +1812,7 @@ paths:
18121812
tags:
18131813
- 'Fax Line'
18141814
summary: 'Get Available Fax Line Area Codes'
1815-
description: 'Returns a response with the area codes available for a given state/provice and city.'
1815+
description: 'Returns a response with the area codes available for a given state/province and city.'
18161816
operationId: faxLineAreaCodeGet
18171817
parameters:
18181818
-

‎openapi.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1609,8 +1609,8 @@ paths:
16091609
get:
16101610
tags:
16111611
- Fax
1612-
summary: 'List Fax Files'
1613-
description: 'Returns list of fax files'
1612+
summary: 'Download Fax Files'
1613+
description: 'Downloads fax files'
16141614
operationId: faxFiles
16151615
parameters:
16161616
-
@@ -1812,7 +1812,7 @@ paths:
18121812
tags:
18131813
- 'Fax Line'
18141814
summary: 'Get Available Fax Line Area Codes'
1815-
description: 'Returns a response with the area codes available for a given state/provice and city.'
1815+
description: 'Returns a response with the area codes available for a given state/province and city.'
18161816
operationId: faxLineAreaCodeGet
18171817
parameters:
18181818
-

‎sdks/dotnet/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Class | Method | HTTP request | Description
142142
*EmbeddedApi* | [**EmbeddedEditUrl**](docs/EmbeddedApi.md#embeddedediturl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL
143143
*EmbeddedApi* | [**EmbeddedSignUrl**](docs/EmbeddedApi.md#embeddedsignurl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL
144144
*FaxApi* | [**FaxDelete**](docs/FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax
145-
*FaxApi* | [**FaxFiles**](docs/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files
145+
*FaxApi* | [**FaxFiles**](docs/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | Download Fax Files
146146
*FaxApi* | [**FaxGet**](docs/FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax
147147
*FaxApi* | [**FaxList**](docs/FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes
148148
*FaxApi* | [**FaxSend**](docs/FaxApi.md#faxsend) | **POST** /fax/send | Send Fax

‎sdks/dotnet/docs/FaxApi.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
55
| Method | HTTP request | Description |
66
|--------|--------------|-------------|
77
| [**FaxDelete**](FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax |
8-
| [**FaxFiles**](FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files |
8+
| [**FaxFiles**](FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | Download Fax Files |
99
| [**FaxGet**](FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax |
1010
| [**FaxList**](FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes |
1111
| [**FaxSend**](FaxApi.md#faxsend) | **POST** /fax/send | Send Fax |
@@ -100,9 +100,9 @@ void (empty response body)
100100
# **FaxFiles**
101101
> System.IO.Stream FaxFiles (string faxId)
102102
103-
List Fax Files
103+
Download Fax Files
104104

105-
Returns list of fax files
105+
Downloads fax files
106106

107107
### Example
108108
```csharp
@@ -149,7 +149,7 @@ This returns an ApiResponse object which contains the response data, status code
149149
```csharp
150150
try
151151
{
152-
// List Fax Files
152+
// Download Fax Files
153153
ApiResponse<System.IO.Stream> response = apiInstance.FaxFilesWithHttpInfo(faxId);
154154
Debug.Write("Status Code: " + response.StatusCode);
155155
Debug.Write("Response Headers: " + response.Headers);

‎sdks/dotnet/docs/FaxLineApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ catch (ApiException e)
113113
114114
Get Available Fax Line Area Codes
115115

116-
Returns a response with the area codes available for a given state/provice and city.
116+
Returns a response with the area codes available for a given state/province and city.
117117

118118
### Example
119119
```csharp

‎sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ public interface IFaxApiSync : IApiAccessor
5151
/// <returns>ApiResponse of Object(void)</returns>
5252
ApiResponse<Object> FaxDeleteWithHttpInfo(string faxId, int operationIndex = 0);
5353
/// <summary>
54-
/// List Fax Files
54+
/// Download Fax Files
5555
/// </summary>
5656
/// <remarks>
57-
/// Returns list of fax files
57+
/// Downloads fax files
5858
/// </remarks>
5959
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
6060
/// <param name="faxId">Fax ID</param>
@@ -63,10 +63,10 @@ public interface IFaxApiSync : IApiAccessor
6363
System.IO.Stream FaxFiles(string faxId, int operationIndex = 0);
6464

6565
/// <summary>
66-
/// List Fax Files
66+
/// Download Fax Files
6767
/// </summary>
6868
/// <remarks>
69-
/// Returns list of fax files
69+
/// Downloads fax files
7070
/// </remarks>
7171
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
7272
/// <param name="faxId">Fax ID</param>
@@ -179,10 +179,10 @@ public interface IFaxApiAsync : IApiAccessor
179179
/// <returns>Task of ApiResponse</returns>
180180
System.Threading.Tasks.Task<ApiResponse<Object>> FaxDeleteWithHttpInfoAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
181181
/// <summary>
182-
/// List Fax Files
182+
/// Download Fax Files
183183
/// </summary>
184184
/// <remarks>
185-
/// Returns list of fax files
185+
/// Downloads fax files
186186
/// </remarks>
187187
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
188188
/// <param name="faxId">Fax ID</param>
@@ -192,10 +192,10 @@ public interface IFaxApiAsync : IApiAccessor
192192
System.Threading.Tasks.Task<System.IO.Stream> FaxFilesAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
193193

194194
/// <summary>
195-
/// List Fax Files
195+
/// Download Fax Files
196196
/// </summary>
197197
/// <remarks>
198-
/// Returns list of fax files
198+
/// Downloads fax files
199199
/// </remarks>
200200
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
201201
/// <param name="faxId">Fax ID</param>
@@ -555,7 +555,7 @@ public Dropbox.Sign.Client.ApiResponse<Object> FaxDeleteWithHttpInfo(string faxI
555555
}
556556

557557
/// <summary>
558-
/// List Fax Files Returns list of fax files
558+
/// Download Fax Files Downloads fax files
559559
/// </summary>
560560
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
561561
/// <param name="faxId">Fax ID</param>
@@ -568,7 +568,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0)
568568
}
569569

570570
/// <summary>
571-
/// List Fax Files Returns list of fax files
571+
/// Download Fax Files Downloads fax files
572572
/// </summary>
573573
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
574574
/// <param name="faxId">Fax ID</param>
@@ -632,7 +632,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0)
632632
}
633633

634634
/// <summary>
635-
/// List Fax Files Returns list of fax files
635+
/// Download Fax Files Downloads fax files
636636
/// </summary>
637637
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
638638
/// <param name="faxId">Fax ID</param>
@@ -646,7 +646,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0)
646646
}
647647

648648
/// <summary>
649-
/// List Fax Files Returns list of fax files
649+
/// Download Fax Files Downloads fax files
650650
/// </summary>
651651
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
652652
/// <param name="faxId">Fax ID</param>

‎sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public interface IFaxLineApiSync : IApiAccessor
5454
/// Get Available Fax Line Area Codes
5555
/// </summary>
5656
/// <remarks>
57-
/// Returns a response with the area codes available for a given state/provice and city.
57+
/// Returns a response with the area codes available for a given state/province and city.
5858
/// </remarks>
5959
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
6060
/// <param name="country">Filter area codes by country.</param>
@@ -69,7 +69,7 @@ public interface IFaxLineApiSync : IApiAccessor
6969
/// Get Available Fax Line Area Codes
7070
/// </summary>
7171
/// <remarks>
72-
/// Returns a response with the area codes available for a given state/provice and city.
72+
/// Returns a response with the area codes available for a given state/province and city.
7373
/// </remarks>
7474
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
7575
/// <param name="country">Filter area codes by country.</param>
@@ -238,7 +238,7 @@ public interface IFaxLineApiAsync : IApiAccessor
238238
/// Get Available Fax Line Area Codes
239239
/// </summary>
240240
/// <remarks>
241-
/// Returns a response with the area codes available for a given state/provice and city.
241+
/// Returns a response with the area codes available for a given state/province and city.
242242
/// </remarks>
243243
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
244244
/// <param name="country">Filter area codes by country.</param>
@@ -254,7 +254,7 @@ public interface IFaxLineApiAsync : IApiAccessor
254254
/// Get Available Fax Line Area Codes
255255
/// </summary>
256256
/// <remarks>
257-
/// Returns a response with the area codes available for a given state/provice and city.
257+
/// Returns a response with the area codes available for a given state/province and city.
258258
/// </remarks>
259259
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
260260
/// <param name="country">Filter area codes by country.</param>
@@ -689,7 +689,7 @@ public Dropbox.Sign.Client.ApiResponse<FaxLineResponse> FaxLineAddUserWithHttpIn
689689
}
690690

691691
/// <summary>
692-
/// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/provice and city.
692+
/// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city.
693693
/// </summary>
694694
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
695695
/// <param name="country">Filter area codes by country.</param>
@@ -705,7 +705,7 @@ public Dropbox.Sign.Client.ApiResponse<FaxLineResponse> FaxLineAddUserWithHttpIn
705705
}
706706

707707
/// <summary>
708-
/// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/provice and city.
708+
/// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city.
709709
/// </summary>
710710
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
711711
/// <param name="country">Filter area codes by country.</param>
@@ -783,7 +783,7 @@ public Dropbox.Sign.Client.ApiResponse<FaxLineResponse> FaxLineAddUserWithHttpIn
783783
}
784784

785785
/// <summary>
786-
/// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/provice and city.
786+
/// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city.
787787
/// </summary>
788788
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
789789
/// <param name="country">Filter area codes by country.</param>
@@ -800,7 +800,7 @@ public Dropbox.Sign.Client.ApiResponse<FaxLineResponse> FaxLineAddUserWithHttpIn
800800
}
801801

802802
/// <summary>
803-
/// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/provice and city.
803+
/// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city.
804804
/// </summary>
805805
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
806806
/// <param name="country">Filter area codes by country.</param>

‎sdks/java-v1/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ Class | Method | HTTP request | Description
178178
*EmbeddedApi* | [**embeddedEditUrl**](docs/EmbeddedApi.md#embeddedEditUrl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL
179179
*EmbeddedApi* | [**embeddedSignUrl**](docs/EmbeddedApi.md#embeddedSignUrl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL
180180
*FaxApi* | [**faxDelete**](docs/FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax
181-
*FaxApi* | [**faxFiles**](docs/FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files
181+
*FaxApi* | [**faxFiles**](docs/FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download Fax Files
182182
*FaxApi* | [**faxGet**](docs/FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax
183183
*FaxApi* | [**faxList**](docs/FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes
184184
*FaxApi* | [**faxSend**](docs/FaxApi.md#faxSend) | **POST** /fax/send | Send Fax

‎sdks/java-v1/docs/FaxApi.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
55
| Method | HTTP request | Description |
66
|------------- | ------------- | -------------|
77
[**faxDelete**](FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax
8-
[**faxFiles**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files
8+
[**faxFiles**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download Fax Files
99
[**faxGet**](FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax
1010
[**faxList**](FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes
1111
[**faxSend**](FaxApi.md#faxSend) | **POST** /fax/send | Send Fax
@@ -82,9 +82,9 @@ null (empty response body)
8282

8383
> File faxFiles(faxId)
8484
85-
List Fax Files
85+
Download Fax Files
8686

87-
Returns list of fax files
87+
Downloads fax files
8888

8989
### Example
9090

‎sdks/java-v1/docs/FaxLineApi.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ public class Example {
9191
9292
Get Available Fax Line Area Codes
9393

94-
Returns a response with the area codes available for a given state/provice and city.
94+
Returns a response with the area codes available for a given state/province and city.
9595

9696
### Example
9797

0 commit comments

Comments
 (0)