From ef120e64b8592ece5d5d7996f3895cbd93f5ea1d Mon Sep 17 00:00:00 2001 From: Jen Young Date: Tue, 26 Nov 2024 13:56:04 -0800 Subject: [PATCH 1/3] Update descriptions --- openapi-sdk.yaml | 6 ++--- openapi.yaml | 6 ++--- sdks/dotnet/README.md | 2 +- sdks/dotnet/docs/FaxApi.md | 8 +++---- sdks/dotnet/docs/FaxLineApi.md | 2 +- sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs | 24 +++++++++---------- .../dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs | 16 ++++++------- sdks/java-v1/README.md | 2 +- sdks/java-v1/docs/FaxApi.md | 6 ++--- sdks/java-v1/docs/FaxLineApi.md | 2 +- .../java/com/dropbox/sign/api/FaxApi.java | 4 ++-- .../java/com/dropbox/sign/api/FaxLineApi.java | 4 ++-- sdks/java-v2/README.md | 2 +- sdks/java-v2/docs/FaxApi.md | 6 ++--- sdks/java-v2/docs/FaxLineApi.md | 2 +- .../java/com/dropbox/sign/api/FaxApi.java | 8 +++---- .../java/com/dropbox/sign/api/FaxLineApi.java | 4 ++-- sdks/node/README.md | 2 +- sdks/node/api/faxApi.ts | 4 ++-- sdks/node/api/faxLineApi.ts | 2 +- sdks/node/docs/api/FaxApi.md | 6 ++--- sdks/node/docs/api/FaxLineApi.md | 2 +- translations/en.yaml | 6 ++--- 23 files changed, 63 insertions(+), 63 deletions(-) diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 6b3b73719..37c239f06 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -1609,8 +1609,8 @@ paths: get: tags: - Fax - summary: 'List Fax Files' - description: 'Returns list of fax files' + summary: 'Download Fax Files' + description: 'Downloads fax files' operationId: faxFiles parameters: - @@ -1812,7 +1812,7 @@ paths: tags: - 'Fax Line' summary: 'Get Available Fax Line Area Codes' - description: 'Returns a response with the area codes available for a given state/provice and city.' + description: 'Returns a response with the area codes available for a given state/province and city.' operationId: faxLineAreaCodeGet parameters: - diff --git a/openapi.yaml b/openapi.yaml index 356e25cc0..5d9b04275 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1609,8 +1609,8 @@ paths: get: tags: - Fax - summary: 'List Fax Files' - description: 'Returns list of fax files' + summary: 'Download Fax Files' + description: 'Downloads fax files' operationId: faxFiles parameters: - @@ -1812,7 +1812,7 @@ paths: tags: - 'Fax Line' summary: 'Get Available Fax Line Area Codes' - description: 'Returns a response with the area codes available for a given state/provice and city.' + description: 'Returns a response with the area codes available for a given state/province and city.' operationId: faxLineAreaCodeGet parameters: - diff --git a/sdks/dotnet/README.md b/sdks/dotnet/README.md index 176cb9fa5..891b0a3d7 100644 --- a/sdks/dotnet/README.md +++ b/sdks/dotnet/README.md @@ -142,7 +142,7 @@ Class | Method | HTTP request | Description *EmbeddedApi* | [**EmbeddedEditUrl**](docs/EmbeddedApi.md#embeddedediturl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL *EmbeddedApi* | [**EmbeddedSignUrl**](docs/EmbeddedApi.md#embeddedsignurl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL *FaxApi* | [**FaxDelete**](docs/FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax -*FaxApi* | [**FaxFiles**](docs/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files +*FaxApi* | [**FaxFiles**](docs/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | Download Fax Files *FaxApi* | [**FaxGet**](docs/FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax *FaxApi* | [**FaxList**](docs/FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes *FaxApi* | [**FaxSend**](docs/FaxApi.md#faxsend) | **POST** /fax/send | Send Fax diff --git a/sdks/dotnet/docs/FaxApi.md b/sdks/dotnet/docs/FaxApi.md index 303d4eff9..207d25611 100644 --- a/sdks/dotnet/docs/FaxApi.md +++ b/sdks/dotnet/docs/FaxApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | Method | HTTP request | Description | |--------|--------------|-------------| | [**FaxDelete**](FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax | -| [**FaxFiles**](FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files | +| [**FaxFiles**](FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | Download Fax Files | | [**FaxGet**](FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax | | [**FaxList**](FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes | | [**FaxSend**](FaxApi.md#faxsend) | **POST** /fax/send | Send Fax | @@ -100,9 +100,9 @@ void (empty response body) # **FaxFiles** > System.IO.Stream FaxFiles (string faxId) -List Fax Files +Download Fax Files -Returns list of fax files +Downloads fax files ### Example ```csharp @@ -149,7 +149,7 @@ This returns an ApiResponse object which contains the response data, status code ```csharp try { - // List Fax Files + // Download Fax Files ApiResponse response = apiInstance.FaxFilesWithHttpInfo(faxId); Debug.Write("Status Code: " + response.StatusCode); Debug.Write("Response Headers: " + response.Headers); diff --git a/sdks/dotnet/docs/FaxLineApi.md b/sdks/dotnet/docs/FaxLineApi.md index 9fdd09ba0..ea3109c8a 100644 --- a/sdks/dotnet/docs/FaxLineApi.md +++ b/sdks/dotnet/docs/FaxLineApi.md @@ -113,7 +113,7 @@ catch (ApiException e) Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a response with the area codes available for a given state/province and city. ### Example ```csharp diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs index b9819df28..5ff4251f5 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs @@ -51,10 +51,10 @@ public interface IFaxApiSync : IApiAccessor /// ApiResponse of Object(void) ApiResponse FaxDeleteWithHttpInfo(string faxId, int operationIndex = 0); /// - /// List Fax Files + /// Download Fax Files /// /// - /// Returns list of fax files + /// Downloads fax files /// /// Thrown when fails to make API call /// Fax ID @@ -63,10 +63,10 @@ public interface IFaxApiSync : IApiAccessor System.IO.Stream FaxFiles(string faxId, int operationIndex = 0); /// - /// List Fax Files + /// Download Fax Files /// /// - /// Returns list of fax files + /// Downloads fax files /// /// Thrown when fails to make API call /// Fax ID @@ -179,10 +179,10 @@ public interface IFaxApiAsync : IApiAccessor /// Task of ApiResponse System.Threading.Tasks.Task> FaxDeleteWithHttpInfoAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// - /// List Fax Files + /// Download Fax Files /// /// - /// Returns list of fax files + /// Downloads fax files /// /// Thrown when fails to make API call /// Fax ID @@ -192,10 +192,10 @@ public interface IFaxApiAsync : IApiAccessor System.Threading.Tasks.Task FaxFilesAsync(string faxId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken)); /// - /// List Fax Files + /// Download Fax Files /// /// - /// Returns list of fax files + /// Downloads fax files /// /// Thrown when fails to make API call /// Fax ID @@ -555,7 +555,7 @@ public Dropbox.Sign.Client.ApiResponse FaxDeleteWithHttpInfo(string faxI } /// - /// List Fax Files Returns list of fax files + /// Download Fax Files Downloads fax files /// /// Thrown when fails to make API call /// Fax ID @@ -568,7 +568,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// List Fax Files Returns list of fax files + /// Download Fax Files Downloads fax files /// /// Thrown when fails to make API call /// Fax ID @@ -632,7 +632,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// List Fax Files Returns list of fax files + /// Download Fax Files Downloads fax files /// /// Thrown when fails to make API call /// Fax ID @@ -646,7 +646,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// List Fax Files Returns list of fax files + /// Download Fax Files Downloads fax files /// /// Thrown when fails to make API call /// Fax ID diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs index edb0eb516..38f303895 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs @@ -54,7 +54,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/provice and city. + /// Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. @@ -69,7 +69,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/provice and city. + /// Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. @@ -238,7 +238,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/provice and city. + /// Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. @@ -254,7 +254,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/provice and city. + /// Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. @@ -689,7 +689,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/provice and city. + /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. @@ -705,7 +705,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/provice and city. + /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. @@ -783,7 +783,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/provice and city. + /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. @@ -800,7 +800,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/provice and city. + /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. /// /// Thrown when fails to make API call /// Filter area codes by country. diff --git a/sdks/java-v1/README.md b/sdks/java-v1/README.md index 84f76aaad..d617b57f2 100644 --- a/sdks/java-v1/README.md +++ b/sdks/java-v1/README.md @@ -178,7 +178,7 @@ Class | Method | HTTP request | Description *EmbeddedApi* | [**embeddedEditUrl**](docs/EmbeddedApi.md#embeddedEditUrl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL *EmbeddedApi* | [**embeddedSignUrl**](docs/EmbeddedApi.md#embeddedSignUrl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL *FaxApi* | [**faxDelete**](docs/FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax -*FaxApi* | [**faxFiles**](docs/FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files +*FaxApi* | [**faxFiles**](docs/FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download Fax Files *FaxApi* | [**faxGet**](docs/FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax *FaxApi* | [**faxList**](docs/FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes *FaxApi* | [**faxSend**](docs/FaxApi.md#faxSend) | **POST** /fax/send | Send Fax diff --git a/sdks/java-v1/docs/FaxApi.md b/sdks/java-v1/docs/FaxApi.md index a3d9baef9..16102c5a4 100644 --- a/sdks/java-v1/docs/FaxApi.md +++ b/sdks/java-v1/docs/FaxApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | Method | HTTP request | Description | |------------- | ------------- | -------------| [**faxDelete**](FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax -[**faxFiles**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files +[**faxFiles**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download Fax Files [**faxGet**](FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax [**faxList**](FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes [**faxSend**](FaxApi.md#faxSend) | **POST** /fax/send | Send Fax @@ -82,9 +82,9 @@ null (empty response body) > File faxFiles(faxId) -List Fax Files +Download Fax Files -Returns list of fax files +Downloads fax files ### Example diff --git a/sdks/java-v1/docs/FaxLineApi.md b/sdks/java-v1/docs/FaxLineApi.md index 1997f1f12..3aa4f8c4c 100644 --- a/sdks/java-v1/docs/FaxLineApi.md +++ b/sdks/java-v1/docs/FaxLineApi.md @@ -91,7 +91,7 @@ public class Example { Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a response with the area codes available for a given state/province and city. ### Example diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java index ce101cc84..bf79b4f83 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxApi.java @@ -113,7 +113,7 @@ public ApiResponse faxDeleteWithHttpInfo(String faxId) throws ApiException } /** - * List Fax Files. Returns list of fax files + * Download Fax Files. Downloads fax files * * @param faxId Fax ID (required) * @return File @@ -130,7 +130,7 @@ public File faxFiles(String faxId) throws ApiException { } /** - * List Fax Files. Returns list of fax files + * Download Fax Files. Downloads fax files * * @param faxId Fax ID (required) * @return ApiResponse<File> diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java index 8d67ba4f1..6f35fb7aa 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/api/FaxLineApi.java @@ -121,7 +121,7 @@ public ApiResponse faxLineAddUserWithHttpInfo( /** * Get Available Fax Line Area Codes. Returns a response with the area codes available for a - * given state/provice and city. + * given state/province and city. * * @param country Filter area codes by country. (required) * @param state Filter area codes by state. (optional) @@ -208,7 +208,7 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo( /** * Get Available Fax Line Area Codes. Returns a response with the area codes available for a - * given state/provice and city. + * given state/province and city. * * @param country Filter area codes by country. (required) * @param state Filter area codes by state. (optional) diff --git a/sdks/java-v2/README.md b/sdks/java-v2/README.md index 3b2e2a381..3e5d9bd37 100644 --- a/sdks/java-v2/README.md +++ b/sdks/java-v2/README.md @@ -154,7 +154,7 @@ Class | Method | HTTP request | Description *EmbeddedApi* | [**embeddedEditUrl**](docs/EmbeddedApi.md#embeddedEditUrl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL *EmbeddedApi* | [**embeddedSignUrl**](docs/EmbeddedApi.md#embeddedSignUrl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL *FaxApi* | [**faxDelete**](docs/FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax -*FaxApi* | [**faxFiles**](docs/FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files +*FaxApi* | [**faxFiles**](docs/FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download Fax Files *FaxApi* | [**faxGet**](docs/FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax *FaxApi* | [**faxList**](docs/FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes *FaxApi* | [**faxSend**](docs/FaxApi.md#faxSend) | **POST** /fax/send | Send Fax diff --git a/sdks/java-v2/docs/FaxApi.md b/sdks/java-v2/docs/FaxApi.md index a3d9baef9..16102c5a4 100644 --- a/sdks/java-v2/docs/FaxApi.md +++ b/sdks/java-v2/docs/FaxApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | Method | HTTP request | Description | |------------- | ------------- | -------------| [**faxDelete**](FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax -[**faxFiles**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files +[**faxFiles**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download Fax Files [**faxGet**](FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax [**faxList**](FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes [**faxSend**](FaxApi.md#faxSend) | **POST** /fax/send | Send Fax @@ -82,9 +82,9 @@ null (empty response body) > File faxFiles(faxId) -List Fax Files +Download Fax Files -Returns list of fax files +Downloads fax files ### Example diff --git a/sdks/java-v2/docs/FaxLineApi.md b/sdks/java-v2/docs/FaxLineApi.md index 1997f1f12..3aa4f8c4c 100644 --- a/sdks/java-v2/docs/FaxLineApi.md +++ b/sdks/java-v2/docs/FaxLineApi.md @@ -91,7 +91,7 @@ public class Example { Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a response with the area codes available for a given state/province and city. ### Example diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java index e010c8323..a42076f38 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxApi.java @@ -114,8 +114,8 @@ public ApiResponse faxDeleteWithHttpInfo(String faxId) throws ApiException ); } /** - * List Fax Files. - * Returns list of fax files + * Download Fax Files. + * Downloads fax files * @param faxId Fax ID (required) * @return File * @throws ApiException if fails to make API call @@ -132,8 +132,8 @@ public File faxFiles(String faxId) throws ApiException { /** - * List Fax Files. - * Returns list of fax files + * Download Fax Files. + * Downloads fax files * @param faxId Fax ID (required) * @return ApiResponse<File> * @throws ApiException if fails to make API call diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java index 3555e15cd..c6d9a5eea 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/api/FaxLineApi.java @@ -116,7 +116,7 @@ public ApiResponse faxLineAddUserWithHttpInfo(FaxLineAddUserReq } /** * Get Available Fax Line Area Codes. - * Returns a response with the area codes available for a given state/provice and city. + * Returns a response with the area codes available for a given state/province and city. * @param country Filter area codes by country. (required) * @param state Filter area codes by state. (optional) * @param province Filter area codes by province. (optional) @@ -198,7 +198,7 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo(St /** * Get Available Fax Line Area Codes. - * Returns a response with the area codes available for a given state/provice and city. + * Returns a response with the area codes available for a given state/province and city. * @param country Filter area codes by country. (required) * @param state Filter area codes by state. (optional) * @param province Filter area codes by province. (optional) diff --git a/sdks/node/README.md b/sdks/node/README.md index bfee7884f..7e05e443f 100644 --- a/sdks/node/README.md +++ b/sdks/node/README.md @@ -121,7 +121,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | *EmbeddedApi* | [**embeddedEditUrl**](./docs/api/EmbeddedApi.md#embeddedediturl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL | | *EmbeddedApi* | [**embeddedSignUrl**](./docs/api/EmbeddedApi.md#embeddedsignurl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL | | *FaxApi* | [**faxDelete**](./docs/api/FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax | -| *FaxApi* | [**faxFiles**](./docs/api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files | +| *FaxApi* | [**faxFiles**](./docs/api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | Download Fax Files | | *FaxApi* | [**faxGet**](./docs/api/FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax | | *FaxApi* | [**faxList**](./docs/api/FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes | | *FaxApi* | [**faxSend**](./docs/api/FaxApi.md#faxsend) | **POST** /fax/send | Send Fax | diff --git a/sdks/node/api/faxApi.ts b/sdks/node/api/faxApi.ts index dd9c6df2a..fdb7f9e9f 100644 --- a/sdks/node/api/faxApi.ts +++ b/sdks/node/api/faxApi.ts @@ -220,8 +220,8 @@ export class FaxApi { }); } /** - * Returns list of fax files - * @summary List Fax Files + * Downloads fax files + * @summary Download Fax Files * @param faxId Fax ID * @param options */ diff --git a/sdks/node/api/faxLineApi.ts b/sdks/node/api/faxLineApi.ts index 634f6149a..e9ca6c40d 100644 --- a/sdks/node/api/faxLineApi.ts +++ b/sdks/node/api/faxLineApi.ts @@ -261,7 +261,7 @@ export class FaxLineApi { }); } /** - * Returns a response with the area codes available for a given state/provice and city. + * Returns a response with the area codes available for a given state/province and city. * @summary Get Available Fax Line Area Codes * @param country Filter area codes by country. * @param state Filter area codes by state. diff --git a/sdks/node/docs/api/FaxApi.md b/sdks/node/docs/api/FaxApi.md index 84ccc7b39..775241da2 100644 --- a/sdks/node/docs/api/FaxApi.md +++ b/sdks/node/docs/api/FaxApi.md @@ -5,7 +5,7 @@ All URIs are relative to https://api.hellosign.com/v3. | Method | HTTP request | Description | | ------------- | ------------- | ------------- | | [**faxDelete()**](FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax | -| [**faxFiles()**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files | +| [**faxFiles()**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download Fax Files | | [**faxGet()**](FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax | | [**faxList()**](FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes | | [**faxSend()**](FaxApi.md#faxSend) | **POST** /fax/send | Send Fax | @@ -88,9 +88,9 @@ void (empty response body) faxFiles(faxId: string): Buffer ``` -List Fax Files +Download Fax Files -Returns list of fax files +Downloads fax files ### TypeScript Example diff --git a/sdks/node/docs/api/FaxLineApi.md b/sdks/node/docs/api/FaxLineApi.md index 4d9f6208b..ab90dd93e 100644 --- a/sdks/node/docs/api/FaxLineApi.md +++ b/sdks/node/docs/api/FaxLineApi.md @@ -104,7 +104,7 @@ faxLineAreaCodeGet(country: 'CA' | 'US' | 'UK', state: 'AK' | 'AL' | 'AR' | 'AZ' Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a response with the area codes available for a given state/province and city. ### TypeScript Example diff --git a/translations/en.yaml b/translations/en.yaml index 6397d4aa8..08ddccc5f 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -135,8 +135,8 @@ "FaxParam::FAX_ID": Fax ID "FaxDelete::SUMMARY": Delete Fax "FaxDelete::DESCRIPTION": Deletes the specified Fax from the system. -"FaxFiles::SUMMARY": List Fax Files -"FaxFiles::DESCRIPTION": Returns list of fax files +"FaxFiles::SUMMARY": Download Fax Files +"FaxFiles::DESCRIPTION": Downloads fax files "FaxList::SUMMARY": Lists Faxes "FaxList::DESCRIPTION": Returns properties of multiple faxes "FaxList::PAGE": Page @@ -175,7 +175,7 @@ "FaxLineAddUser::ACCOUNT_ID": Account ID "FaxLineAddUser::EMAIL_ADDRESS": Email address "FaxLineAreaCodeGet::SUMMARY": Get Available Fax Line Area Codes -"FaxLineAreaCodeGet::DESCRIPTION": Returns a response with the area codes available for a given state/provice and city. +"FaxLineAreaCodeGet::DESCRIPTION": Returns a response with the area codes available for a given state/province and city. "FaxLineAreaCodeGet::CITY": Filter area codes by city. "FaxLineAreaCodeGet::STATE": Filter area codes by state. "FaxLineAreaCodeGet::PROVINCE": Filter area codes by province. From 3e387e36e132e0e9bf353e1137c7378c4b88c299 Mon Sep 17 00:00:00 2001 From: Jen Young Date: Tue, 26 Nov 2024 14:49:44 -0800 Subject: [PATCH 2/3] Update sdks --- sdks/php/README.md | 2 +- sdks/php/docs/Api/FaxApi.md | 6 +++--- sdks/php/docs/Api/FaxLineApi.md | 2 +- sdks/php/src/Api/FaxApi.php | 8 ++++---- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/sdks/php/README.md b/sdks/php/README.md index a37c54fe5..da5c537e8 100644 --- a/sdks/php/README.md +++ b/sdks/php/README.md @@ -161,7 +161,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | *EmbeddedApi* | [**embeddedEditUrl**](docs/Api/EmbeddedApi.md#embeddedediturl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL | | *EmbeddedApi* | [**embeddedSignUrl**](docs/Api/EmbeddedApi.md#embeddedsignurl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL | | *FaxApi* | [**faxDelete**](docs/Api/FaxApi.md#faxdelete) | **DELETE** /fax/{fax_id} | Delete Fax | -| *FaxApi* | [**faxFiles**](docs/Api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | List Fax Files | +| *FaxApi* | [**faxFiles**](docs/Api/FaxApi.md#faxfiles) | **GET** /fax/files/{fax_id} | Download Fax Files | | *FaxApi* | [**faxGet**](docs/Api/FaxApi.md#faxget) | **GET** /fax/{fax_id} | Get Fax | | *FaxApi* | [**faxList**](docs/Api/FaxApi.md#faxlist) | **GET** /fax/list | Lists Faxes | | *FaxApi* | [**faxSend**](docs/Api/FaxApi.md#faxsend) | **POST** /fax/send | Send Fax | diff --git a/sdks/php/docs/Api/FaxApi.md b/sdks/php/docs/Api/FaxApi.md index 8b68458c6..78e411118 100644 --- a/sdks/php/docs/Api/FaxApi.md +++ b/sdks/php/docs/Api/FaxApi.md @@ -5,7 +5,7 @@ All URIs are relative to https://api.hellosign.com/v3. | Method | HTTP request | Description | | ------------- | ------------- | ------------- | | [**faxDelete()**](FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax | -| [**faxFiles()**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files | +| [**faxFiles()**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download Fax Files | | [**faxGet()**](FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax | | [**faxList()**](FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes | | [**faxSend()**](FaxApi.md#faxSend) | **POST** /fax/send | Send Fax | @@ -72,9 +72,9 @@ void (empty response body) ```php faxFiles($fax_id): \SplFileObject ``` -List Fax Files +Download Fax Files -Returns list of fax files +Downloads fax files ### Example diff --git a/sdks/php/docs/Api/FaxLineApi.md b/sdks/php/docs/Api/FaxLineApi.md index 1bb340d36..44789fc33 100644 --- a/sdks/php/docs/Api/FaxLineApi.md +++ b/sdks/php/docs/Api/FaxLineApi.md @@ -81,7 +81,7 @@ faxLineAreaCodeGet($country, $state, $province, $city): \Dropbox\Sign\Model\FaxL ``` Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a response with the area codes available for a given state/province and city. ### Example diff --git a/sdks/php/src/Api/FaxApi.php b/sdks/php/src/Api/FaxApi.php index 0ae0cf38d..619778c5b 100644 --- a/sdks/php/src/Api/FaxApi.php +++ b/sdks/php/src/Api/FaxApi.php @@ -385,7 +385,7 @@ public function faxDeleteRequest(string $fax_id, string $contentType = self::con /** * Operation faxFiles * - * List Fax Files + * Download Fax Files * * @param string $fax_id Fax ID (required) * @@ -402,7 +402,7 @@ public function faxFiles(string $fax_id) /** * Operation faxFilesWithHttpInfo * - * List Fax Files + * Download Fax Files * * @param string $fax_id Fax ID (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation @@ -539,7 +539,7 @@ public function faxFilesWithHttpInfo(string $fax_id, string $contentType = self: /** * Operation faxFilesAsync * - * List Fax Files + * Download Fax Files * * @param string $fax_id Fax ID (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation @@ -561,7 +561,7 @@ function ($response) { /** * Operation faxFilesAsyncWithHttpInfo * - * List Fax Files + * Download Fax Files * * @param string $fax_id Fax ID (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxFiles'] to see the possible values for this operation From dd569a16653afe3f29724d3441064bad82065f6d Mon Sep 17 00:00:00 2001 From: Jen Young Date: Tue, 26 Nov 2024 15:05:51 -0800 Subject: [PATCH 3/3] Update ruby and python --- sdks/python/README.md | 2 +- sdks/python/docs/FaxApi.md | 6 +++--- sdks/python/docs/FaxLineApi.md | 2 +- sdks/python/dropbox_sign/api/fax_api.py | 12 ++++++------ sdks/python/dropbox_sign/api/fax_line_api.py | 6 +++--- sdks/ruby/README.md | 2 +- sdks/ruby/docs/FaxApi.md | 8 ++++---- sdks/ruby/docs/FaxLineApi.md | 2 +- sdks/ruby/lib/dropbox-sign/api/fax_api.rb | 8 ++++---- sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb | 4 ++-- 10 files changed, 26 insertions(+), 26 deletions(-) diff --git a/sdks/python/README.md b/sdks/python/README.md index 796399702..56f5d80f1 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -116,7 +116,7 @@ Class | Method | HTTP request | Description |```EmbeddedApi``` | [```embedded_edit_url```](docs/EmbeddedApi.md#embedded_edit_url) | ```POST /embedded/edit_url/{template_id}``` | Get Embedded Template Edit URL| ```EmbeddedApi``` | [```embedded_sign_url```](docs/EmbeddedApi.md#embedded_sign_url) | ```GET /embedded/sign_url/{signature_id}``` | Get Embedded Sign URL| |```FaxApi``` | [```fax_delete```](docs/FaxApi.md#fax_delete) | ```DELETE /fax/{fax_id}``` | Delete Fax| -```FaxApi``` | [```fax_files```](docs/FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | List Fax Files| +```FaxApi``` | [```fax_files```](docs/FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | Download Fax Files| ```FaxApi``` | [```fax_get```](docs/FaxApi.md#fax_get) | ```GET /fax/{fax_id}``` | Get Fax| ```FaxApi``` | [```fax_list```](docs/FaxApi.md#fax_list) | ```GET /fax/list``` | Lists Faxes| ```FaxApi``` | [```fax_send```](docs/FaxApi.md#fax_send) | ```POST /fax/send``` | Send Fax| diff --git a/sdks/python/docs/FaxApi.md b/sdks/python/docs/FaxApi.md index a0b2cbd12..93ec15305 100644 --- a/sdks/python/docs/FaxApi.md +++ b/sdks/python/docs/FaxApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- |[```fax_delete```](FaxApi.md#fax_delete) | ```DELETE /fax/{fax_id}``` | Delete Fax| -|[```fax_files```](FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | List Fax Files| +|[```fax_files```](FaxApi.md#fax_files) | ```GET /fax/files/{fax_id}``` | Download Fax Files| |[```fax_get```](FaxApi.md#fax_get) | ```GET /fax/{fax_id}``` | Get Fax| |[```fax_list```](FaxApi.md#fax_list) | ```GET /fax/list``` | Lists Faxes| |[```fax_send```](FaxApi.md#fax_send) | ```POST /fax/send``` | Send Fax| @@ -73,9 +73,9 @@ void (empty response body) # ```fax_files``` > ```io.IOBase fax_files(fax_id)``` -List Fax Files +Download Fax Files -Returns list of fax files +Downloads fax files ### Example diff --git a/sdks/python/docs/FaxLineApi.md b/sdks/python/docs/FaxLineApi.md index 27ec4d08b..0846b3384 100644 --- a/sdks/python/docs/FaxLineApi.md +++ b/sdks/python/docs/FaxLineApi.md @@ -83,7 +83,7 @@ with ApiClient(configuration) as api_client: Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a response with the area codes available for a given state/province and city. ### Example diff --git a/sdks/python/dropbox_sign/api/fax_api.py b/sdks/python/dropbox_sign/api/fax_api.py index 3e49a160a..695dd29c9 100644 --- a/sdks/python/dropbox_sign/api/fax_api.py +++ b/sdks/python/dropbox_sign/api/fax_api.py @@ -301,9 +301,9 @@ def fax_files( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> io.IOBase: - """List Fax Files + """Download Fax Files - Returns list of fax files + Downloads fax files :param fax_id: Fax ID (required) :type fax_id: str @@ -366,9 +366,9 @@ def fax_files_with_http_info( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> ApiResponse[io.IOBase]: - """List Fax Files + """Download Fax Files - Returns list of fax files + Downloads fax files :param fax_id: Fax ID (required) :type fax_id: str @@ -431,9 +431,9 @@ def fax_files_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List Fax Files + """Download Fax Files - Returns list of fax files + Downloads fax files :param fax_id: Fax ID (required) :type fax_id: str diff --git a/sdks/python/dropbox_sign/api/fax_line_api.py b/sdks/python/dropbox_sign/api/fax_line_api.py index 2fbb5ac99..e32d2b234 100644 --- a/sdks/python/dropbox_sign/api/fax_line_api.py +++ b/sdks/python/dropbox_sign/api/fax_line_api.py @@ -352,7 +352,7 @@ def fax_line_area_code_get( ) -> FaxLineAreaCodeGetResponse: """Get Available Fax Line Area Codes - Returns a response with the area codes available for a given state/provice and city. + Returns a response with the area codes available for a given state/province and city. :param country: Filter area codes by country. (required) :type country: str @@ -437,7 +437,7 @@ def fax_line_area_code_get_with_http_info( ) -> ApiResponse[FaxLineAreaCodeGetResponse]: """Get Available Fax Line Area Codes - Returns a response with the area codes available for a given state/provice and city. + Returns a response with the area codes available for a given state/province and city. :param country: Filter area codes by country. (required) :type country: str @@ -522,7 +522,7 @@ def fax_line_area_code_get_without_preload_content( ) -> RESTResponseType: """Get Available Fax Line Area Codes - Returns a response with the area codes available for a given state/provice and city. + Returns a response with the area codes available for a given state/province and city. :param country: Filter area codes by country. (required) :type country: str diff --git a/sdks/ruby/README.md b/sdks/ruby/README.md index e93c857b9..4e85ddc15 100644 --- a/sdks/ruby/README.md +++ b/sdks/ruby/README.md @@ -122,7 +122,7 @@ All URIs are relative to *https://api.hellosign.com/v3* |*Dropbox::Sign::EmbeddedApi* | [**embedded_edit_url**](docs/EmbeddedApi.md#embedded_edit_url) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL | |*Dropbox::Sign::EmbeddedApi* | [**embedded_sign_url**](docs/EmbeddedApi.md#embedded_sign_url) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL | |*Dropbox::Sign::FaxApi* | [**fax_delete**](docs/FaxApi.md#fax_delete) | **DELETE** /fax/{fax_id} | Delete Fax | -|*Dropbox::Sign::FaxApi* | [**fax_files**](docs/FaxApi.md#fax_files) | **GET** /fax/files/{fax_id} | List Fax Files | +|*Dropbox::Sign::FaxApi* | [**fax_files**](docs/FaxApi.md#fax_files) | **GET** /fax/files/{fax_id} | Download Fax Files | |*Dropbox::Sign::FaxApi* | [**fax_get**](docs/FaxApi.md#fax_get) | **GET** /fax/{fax_id} | Get Fax | |*Dropbox::Sign::FaxApi* | [**fax_list**](docs/FaxApi.md#fax_list) | **GET** /fax/list | Lists Faxes | |*Dropbox::Sign::FaxApi* | [**fax_send**](docs/FaxApi.md#fax_send) | **POST** /fax/send | Send Fax | diff --git a/sdks/ruby/docs/FaxApi.md b/sdks/ruby/docs/FaxApi.md index 23129b6d7..a0e05a605 100644 --- a/sdks/ruby/docs/FaxApi.md +++ b/sdks/ruby/docs/FaxApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [`fax_delete`](FaxApi.md#fax_delete) | **DELETE** `/fax/{fax_id}` | Delete Fax | -| [`fax_files`](FaxApi.md#fax_files) | **GET** `/fax/files/{fax_id}` | List Fax Files | +| [`fax_files`](FaxApi.md#fax_files) | **GET** `/fax/files/{fax_id}` | Download Fax Files | | [`fax_get`](FaxApi.md#fax_get) | **GET** `/fax/{fax_id}` | Get Fax | | [`fax_list`](FaxApi.md#fax_list) | **GET** `/fax/list` | Lists Faxes | | [`fax_send`](FaxApi.md#fax_send) | **POST** `/fax/send` | Send Fax | @@ -81,9 +81,9 @@ nil (empty response body) > `File fax_files(fax_id)` -List Fax Files +Download Fax Files -Returns list of fax files +Downloads fax files ### Examples @@ -116,7 +116,7 @@ This returns an Array which contains the response data, status code and headers. ```ruby begin - # List Fax Files + # Download Fax Files data, status_code, headers = api_instance.fax_files_with_http_info(fax_id) p status_code # => 2xx p headers # => { ... } diff --git a/sdks/ruby/docs/FaxLineApi.md b/sdks/ruby/docs/FaxLineApi.md index f5b1d3b43..49309267e 100644 --- a/sdks/ruby/docs/FaxLineApi.md +++ b/sdks/ruby/docs/FaxLineApi.md @@ -90,7 +90,7 @@ end Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a response with the area codes available for a given state/province and city. ### Examples diff --git a/sdks/ruby/lib/dropbox-sign/api/fax_api.rb b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb index 17fca7916..2df3c1851 100644 --- a/sdks/ruby/lib/dropbox-sign/api/fax_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb @@ -89,8 +89,8 @@ def fax_delete_with_http_info(fax_id, opts = {}) return data, status_code, headers end - # List Fax Files - # Returns list of fax files + # Download Fax Files + # Downloads fax files # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [File] @@ -99,8 +99,8 @@ def fax_files(fax_id, opts = {}) data end - # List Fax Files - # Returns list of fax files + # Download Fax Files + # Downloads fax files # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers diff --git a/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb b/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb index 7adb326d6..a0b9677db 100644 --- a/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb @@ -132,7 +132,7 @@ def fax_line_add_user_with_http_info(fax_line_add_user_request, opts = {}) end # Get Available Fax Line Area Codes - # Returns a response with the area codes available for a given state/provice and city. + # Returns a response with the area codes available for a given state/province and city. # @param country [String] Filter area codes by country. # @param [Hash] opts the optional parameters # @option opts [String] :state Filter area codes by state. @@ -145,7 +145,7 @@ def fax_line_area_code_get(country, opts = {}) end # Get Available Fax Line Area Codes - # Returns a response with the area codes available for a given state/provice and city. + # Returns a response with the area codes available for a given state/province and city. # @param country [String] Filter area codes by country. # @param [Hash] opts the optional parameters # @option opts [String] :state Filter area codes by state.