diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 818930290..304c1c17f 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -1414,7 +1414,7 @@ paths: tags: - Fax summary: 'Get Fax' - description: 'Returns information about fax' + description: 'Returns information about a Fax' operationId: faxGet parameters: - @@ -1510,12 +1510,12 @@ paths: x-meta: seo: title: 'Get Fax | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve properties of a fax, click here.' delete: tags: - Fax summary: 'Delete Fax' - description: 'Deletes the specified Fax from the system.' + description: 'Deletes the specified Fax from the system' operationId: faxDelete parameters: - @@ -1610,7 +1610,7 @@ paths: tags: - Fax summary: 'Download Fax Files' - description: 'Downloads fax files' + description: 'Downloads files associated with a Fax' operationId: faxFiles parameters: - @@ -1706,7 +1706,7 @@ paths: x-meta: seo: title: 'Fax Files | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list the files of a fax, click here.' /fax_line/add_user: put: tags: @@ -1812,13 +1812,13 @@ paths: tags: - 'Fax Line' summary: 'Get Available Fax Line Area Codes' - description: 'Returns a response with the area codes available for a given state/province and city.' + description: 'Returns a list of available area codes for a given state/province and city' operationId: faxLineAreaCodeGet parameters: - name: country in: query - description: 'Filter area codes by country.' + description: 'Filter area codes by country' required: true schema: type: string @@ -1830,7 +1830,7 @@ paths: - name: state in: query - description: 'Filter area codes by state.' + description: 'Filter area codes by state' schema: type: string enum: @@ -1888,7 +1888,7 @@ paths: - name: province in: query - description: 'Filter area codes by province.' + description: 'Filter area codes by province' schema: type: string enum: @@ -1908,7 +1908,7 @@ paths: - name: city in: query - description: 'Filter area codes by city.' + description: 'Filter area codes by city' schema: type: string responses: @@ -1992,13 +1992,13 @@ paths: x-meta: seo: title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here.' /fax_line/create: post: tags: - 'Fax Line' summary: 'Purchase Fax Line' - description: 'Purchases a new Fax Line.' + description: 'Purchases a new Fax Line' operationId: faxLineCreate requestBody: required: true @@ -2104,7 +2104,7 @@ paths: - name: number in: query - description: 'The Fax Line number.' + description: 'The Fax Line number' required: true schema: type: string @@ -2192,7 +2192,7 @@ paths: x-meta: seo: title: 'Get Fax Line | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here.' delete: tags: - 'Fax Line' @@ -2305,7 +2305,7 @@ paths: - name: page in: query - description: Page + description: 'Which page number of the Fax Line List to return. Defaults to `1`.' schema: type: integer default: 1 @@ -2313,7 +2313,7 @@ paths: - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 @@ -2321,7 +2321,7 @@ paths: - name: show_team_lines in: query - description: 'Show team lines' + description: 'Include Fax Lines belonging to team members in the list' schema: type: boolean responses: @@ -2411,7 +2411,7 @@ paths: tags: - 'Fax Line' summary: 'Remove Fax Line Access' - description: 'Removes a user''s access to the specified Fax Line.' + description: 'Removes a user''s access to the specified Fax Line' operationId: faxLineRemoveUser requestBody: required: true @@ -2511,13 +2511,13 @@ paths: tags: - Fax summary: 'Lists Faxes' - description: 'Returns properties of multiple faxes' + description: 'Returns properties of multiple Faxes' operationId: faxList parameters: - name: page in: query - description: Page + description: 'Which page number of the Fax List to return. Defaults to `1`.' schema: type: integer default: 1 @@ -2526,7 +2526,7 @@ paths: - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 @@ -2620,7 +2620,7 @@ paths: tags: - Fax summary: 'Send Fax' - description: 'Action to prepare and send a fax' + description: 'Creates and sends a new Fax with the submitted file(s)' operationId: faxSend requestBody: required: true @@ -2718,7 +2718,7 @@ paths: $ref: examples/FaxSend.sh x-meta: seo: - title: 'Send Fax| API Documentation | Dropbox Fax for Developers' + title: 'Send Fax | API Documentation | Dropbox Fax for Developers' description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.' /oauth/token: post: @@ -7759,7 +7759,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: description: 'Account ID' @@ -7852,10 +7852,10 @@ components: - country properties: area_code: - description: 'Area code' + description: 'Area code of the new Fax Line' type: integer country: - description: Country + description: 'Country of the area code' type: string enum: - CA @@ -7867,10 +7867,10 @@ components: - Us - Uk city: - description: City + description: 'City of the area code' type: string account_id: - description: 'Account ID' + description: 'Account ID of the account that will be assigned this new Fax Line' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 type: object @@ -7879,7 +7879,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string type: object FaxLineRemoveUserRequest: @@ -7887,14 +7887,14 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: - description: 'Account ID' + description: 'Account ID of the user to remove access' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 email_address: - description: 'Email address' + description: 'Email address of the user to remove access' type: string format: email type: object @@ -7903,7 +7903,9 @@ components: - recipient properties: recipient: - description: 'Fax Send To Recipient' + description: |- + Recipient of the fax + Can be a phone number in E.164 format or email address type: string example: recipient@example.com sender: @@ -7911,13 +7913,19 @@ components: type: string example: sender@example.com files: - description: 'Fax File to Send' + description: |- + Use `files[]` to indicate the uploaded file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: - description: 'Fax File URL to Send' + description: |- + Use `file_urls[]` to have Dropbox Fax download the file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string @@ -7926,11 +7934,11 @@ components: type: boolean default: false cover_page_to: - description: 'Fax Cover Page for Recipient' + description: 'Fax cover page recipient information' type: string example: 'Recipient Name' cover_page_from: - description: 'Fax Cover Page for Sender' + description: 'Fax cover page sender information' type: string example: 'Sender Name' cover_page_message: @@ -13411,7 +13419,7 @@ components: value: $ref: examples/json/FaxLineListResponseExample.json FaxListResponseExample: - summary: 'Returns the properties and settings of multiple Faxes.' + summary: 'Returns the properties and settings of multiple Faxes' value: $ref: examples/json/FaxListResponseExample.json ReportCreateResponseExample: diff --git a/openapi.yaml b/openapi.yaml index d0dbb629b..7baa54892 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1414,7 +1414,7 @@ paths: tags: - Fax summary: 'Get Fax' - description: 'Returns information about fax' + description: 'Returns information about a Fax' operationId: faxGet parameters: - @@ -1510,12 +1510,12 @@ paths: x-meta: seo: title: 'Get Fax | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve properties of a fax, click here.' delete: tags: - Fax summary: 'Delete Fax' - description: 'Deletes the specified Fax from the system.' + description: 'Deletes the specified Fax from the system' operationId: faxDelete parameters: - @@ -1610,7 +1610,7 @@ paths: tags: - Fax summary: 'Download Fax Files' - description: 'Downloads fax files' + description: 'Downloads files associated with a Fax' operationId: faxFiles parameters: - @@ -1706,7 +1706,7 @@ paths: x-meta: seo: title: 'Fax Files | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list the files of a fax, click here.' /fax_line/add_user: put: tags: @@ -1812,13 +1812,13 @@ paths: tags: - 'Fax Line' summary: 'Get Available Fax Line Area Codes' - description: 'Returns a response with the area codes available for a given state/province and city.' + description: 'Returns a list of available area codes for a given state/province and city' operationId: faxLineAreaCodeGet parameters: - name: country in: query - description: 'Filter area codes by country.' + description: 'Filter area codes by country' required: true schema: type: string @@ -1830,7 +1830,7 @@ paths: - name: state in: query - description: 'Filter area codes by state.' + description: 'Filter area codes by state' schema: type: string enum: @@ -1888,7 +1888,7 @@ paths: - name: province in: query - description: 'Filter area codes by province.' + description: 'Filter area codes by province' schema: type: string enum: @@ -1908,7 +1908,7 @@ paths: - name: city in: query - description: 'Filter area codes by city.' + description: 'Filter area codes by city' schema: type: string responses: @@ -1992,13 +1992,13 @@ paths: x-meta: seo: title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here.' /fax_line/create: post: tags: - 'Fax Line' summary: 'Purchase Fax Line' - description: 'Purchases a new Fax Line.' + description: 'Purchases a new Fax Line' operationId: faxLineCreate requestBody: required: true @@ -2104,7 +2104,7 @@ paths: - name: number in: query - description: 'The Fax Line number.' + description: 'The Fax Line number' required: true schema: type: string @@ -2192,7 +2192,7 @@ paths: x-meta: seo: title: 'Get Fax Line | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here.' delete: tags: - 'Fax Line' @@ -2305,7 +2305,7 @@ paths: - name: page in: query - description: Page + description: 'Which page number of the Fax Line List to return. Defaults to `1`.' schema: type: integer default: 1 @@ -2313,7 +2313,7 @@ paths: - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 @@ -2321,7 +2321,7 @@ paths: - name: show_team_lines in: query - description: 'Show team lines' + description: 'Include Fax Lines belonging to team members in the list' schema: type: boolean responses: @@ -2411,7 +2411,7 @@ paths: tags: - 'Fax Line' summary: 'Remove Fax Line Access' - description: 'Removes a user''s access to the specified Fax Line.' + description: 'Removes a user''s access to the specified Fax Line' operationId: faxLineRemoveUser requestBody: required: true @@ -2511,13 +2511,13 @@ paths: tags: - Fax summary: 'Lists Faxes' - description: 'Returns properties of multiple faxes' + description: 'Returns properties of multiple Faxes' operationId: faxList parameters: - name: page in: query - description: Page + description: 'Which page number of the Fax List to return. Defaults to `1`.' schema: type: integer default: 1 @@ -2526,7 +2526,7 @@ paths: - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 @@ -2620,7 +2620,7 @@ paths: tags: - Fax summary: 'Send Fax' - description: 'Action to prepare and send a fax' + description: 'Creates and sends a new Fax with the submitted file(s)' operationId: faxSend requestBody: required: true @@ -2718,7 +2718,7 @@ paths: $ref: examples/FaxSend.sh x-meta: seo: - title: 'Send Fax| API Documentation | Dropbox Fax for Developers' + title: 'Send Fax | API Documentation | Dropbox Fax for Developers' description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.' /oauth/token: post: @@ -7759,7 +7759,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: description: 'Account ID' @@ -7852,10 +7852,10 @@ components: - country properties: area_code: - description: 'Area code' + description: 'Area code of the new Fax Line' type: integer country: - description: Country + description: 'Country of the area code' type: string enum: - CA @@ -7867,10 +7867,10 @@ components: - Us - Uk city: - description: City + description: 'City of the area code' type: string account_id: - description: 'Account ID' + description: 'Account ID of the account that will be assigned this new Fax Line' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 type: object @@ -7879,7 +7879,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string type: object FaxLineRemoveUserRequest: @@ -7887,14 +7887,14 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: - description: 'Account ID' + description: 'Account ID of the user to remove access' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 email_address: - description: 'Email address' + description: 'Email address of the user to remove access' type: string format: email type: object @@ -7903,7 +7903,9 @@ components: - recipient properties: recipient: - description: 'Fax Send To Recipient' + description: |- + Recipient of the fax + Can be a phone number in E.164 format or email address type: string example: recipient@example.com sender: @@ -7911,13 +7913,19 @@ components: type: string example: sender@example.com files: - description: 'Fax File to Send' + description: |- + Use `files[]` to indicate the uploaded file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: - description: 'Fax File URL to Send' + description: |- + Use `file_urls[]` to have Dropbox Fax download the file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string @@ -7926,11 +7934,11 @@ components: type: boolean default: false cover_page_to: - description: 'Fax Cover Page for Recipient' + description: 'Fax cover page recipient information' type: string example: 'Recipient Name' cover_page_from: - description: 'Fax Cover Page for Sender' + description: 'Fax cover page sender information' type: string example: 'Sender Name' cover_page_message: @@ -13389,7 +13397,7 @@ components: value: $ref: examples/json/FaxLineListResponseExample.json FaxListResponseExample: - summary: 'Returns the properties and settings of multiple Faxes.' + summary: 'Returns the properties and settings of multiple Faxes' value: $ref: examples/json/FaxListResponseExample.json ReportCreateResponseExample: diff --git a/sdks/dotnet/docs/FaxApi.md b/sdks/dotnet/docs/FaxApi.md index 207d25611..4368c0732 100644 --- a/sdks/dotnet/docs/FaxApi.md +++ b/sdks/dotnet/docs/FaxApi.md @@ -16,7 +16,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example ```csharp @@ -102,7 +102,7 @@ void (empty response body) Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Example ```csharp @@ -197,7 +197,7 @@ catch (ApiException e) Get Fax -Returns information about fax +Returns information about a Fax ### Example ```csharp @@ -289,7 +289,7 @@ catch (ApiException e) Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example ```csharp @@ -352,8 +352,8 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **page** | **int?** | Page | [optional] [default to 1] | -| **pageSize** | **int?** | Page size | [optional] [default to 20] | +| **page** | **int?** | Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] | +| **pageSize** | **int?** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -383,7 +383,7 @@ catch (ApiException e) Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example ```csharp diff --git a/sdks/dotnet/docs/FaxLineAddUserRequest.md b/sdks/dotnet/docs/FaxLineAddUserRequest.md index f89c0deef..705c9d91d 100644 --- a/sdks/dotnet/docs/FaxLineAddUserRequest.md +++ b/sdks/dotnet/docs/FaxLineAddUserRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Number** | **string** | The Fax Line number. | **AccountId** | **string** | Account ID | [optional] **EmailAddress** | **string** | Email address | [optional] +**Number** | **string** | The Fax Line number | **AccountId** | **string** | Account ID | [optional] **EmailAddress** | **string** | Email address | [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) diff --git a/sdks/dotnet/docs/FaxLineApi.md b/sdks/dotnet/docs/FaxLineApi.md index ea3109c8a..d914fb09b 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/province and city. +Returns a list of available area codes for a given state/province and city ### Example ```csharp @@ -173,10 +173,10 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **country** | **string** | Filter area codes by country. | | -| **state** | **string?** | Filter area codes by state. | [optional] | -| **province** | **string?** | Filter area codes by province. | [optional] | -| **city** | **string?** | Filter area codes by city. | [optional] | +| **country** | **string** | Filter area codes by country | | +| **state** | **string?** | Filter area codes by state | [optional] | +| **province** | **string?** | Filter area codes by province | [optional] | +| **city** | **string?** | Filter area codes by city | [optional] | ### Return type @@ -206,7 +206,7 @@ catch (ApiException e) Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example ```csharp @@ -451,7 +451,7 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| -| **number** | **string** | The Fax Line number. | | +| **number** | **string** | The Fax Line number | | ### Return type @@ -542,9 +542,9 @@ catch (ApiException e) | Name | Type | Description | Notes | |------|------|-------------|-------| | **accountId** | **string?** | Account ID | [optional] | -| **page** | **int?** | Page | [optional] [default to 1] | -| **pageSize** | **int?** | Page size | [optional] [default to 20] | -| **showTeamLines** | **bool?** | Show team lines | [optional] | +| **page** | **int?** | Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] | +| **pageSize** | **int?** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **showTeamLines** | **bool?** | Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -574,7 +574,7 @@ catch (ApiException e) Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example ```csharp diff --git a/sdks/dotnet/docs/FaxLineCreateRequest.md b/sdks/dotnet/docs/FaxLineCreateRequest.md index 21d3ffc88..d8bf8c4d9 100644 --- a/sdks/dotnet/docs/FaxLineCreateRequest.md +++ b/sdks/dotnet/docs/FaxLineCreateRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AreaCode** | **int** | Area code | **Country** | **string** | Country | **City** | **string** | City | [optional] **AccountId** | **string** | Account ID | [optional] +**AreaCode** | **int** | Area code of the new Fax Line | **Country** | **string** | Country of the area code | **City** | **string** | City of the area code | [optional] **AccountId** | **string** | Account ID of the account that will be assigned this new Fax Line | [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) diff --git a/sdks/dotnet/docs/FaxLineDeleteRequest.md b/sdks/dotnet/docs/FaxLineDeleteRequest.md index 673880d28..1d8885b58 100644 --- a/sdks/dotnet/docs/FaxLineDeleteRequest.md +++ b/sdks/dotnet/docs/FaxLineDeleteRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Number** | **string** | The Fax Line number. | +**Number** | **string** | The Fax Line number | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/dotnet/docs/FaxLineRemoveUserRequest.md b/sdks/dotnet/docs/FaxLineRemoveUserRequest.md index 0d73414a7..3be0e7bdb 100644 --- a/sdks/dotnet/docs/FaxLineRemoveUserRequest.md +++ b/sdks/dotnet/docs/FaxLineRemoveUserRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Number** | **string** | The Fax Line number. | **AccountId** | **string** | Account ID | [optional] **EmailAddress** | **string** | Email address | [optional] +**Number** | **string** | The Fax Line number | **AccountId** | **string** | Account ID of the user to remove access | [optional] **EmailAddress** | **string** | Email address of the user to remove access | [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) diff --git a/sdks/dotnet/docs/FaxSendRequest.md b/sdks/dotnet/docs/FaxSendRequest.md index b02d7f0b8..371c7c062 100644 --- a/sdks/dotnet/docs/FaxSendRequest.md +++ b/sdks/dotnet/docs/FaxSendRequest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Recipient** | **string** | Fax Send To Recipient | **Sender** | **string** | Fax Send From Sender (used only with fax number) | [optional] **Files** | **List<System.IO.Stream>** | Fax File to Send | [optional] **FileUrls** | **List<string>** | Fax File URL to Send | [optional] **TestMode** | **bool** | API Test Mode Setting | [optional] [default to false]**CoverPageTo** | **string** | Fax Cover Page for Recipient | [optional] **CoverPageFrom** | **string** | Fax Cover Page for Sender | [optional] **CoverPageMessage** | **string** | Fax Cover Page Message | [optional] **Title** | **string** | Fax Title | [optional] +**Recipient** | **string** | Recipient of the fax Can be a phone number in E.164 format or email address | **Sender** | **string** | Fax Send From Sender (used only with fax number) | [optional] **Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | [optional] **TestMode** | **bool** | API Test Mode Setting | [optional] [default to false]**CoverPageTo** | **string** | Fax cover page recipient information | [optional] **CoverPageFrom** | **string** | Fax cover page sender information | [optional] **CoverPageMessage** | **string** | Fax Cover Page Message | [optional] **Title** | **string** | Fax Title | [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) diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs index 5ff4251f5..096d3bf66 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/FaxApi.cs @@ -31,7 +31,7 @@ public interface IFaxApiSync : IApiAccessor /// Delete Fax /// /// - /// Deletes the specified Fax from the system. + /// Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -43,7 +43,7 @@ public interface IFaxApiSync : IApiAccessor /// Delete Fax /// /// - /// Deletes the specified Fax from the system. + /// Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -54,7 +54,7 @@ public interface IFaxApiSync : IApiAccessor /// Download Fax Files /// /// - /// Downloads fax files + /// Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -66,7 +66,7 @@ public interface IFaxApiSync : IApiAccessor /// Download Fax Files /// /// - /// Downloads fax files + /// Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -77,7 +77,7 @@ public interface IFaxApiSync : IApiAccessor /// Get Fax /// /// - /// Returns information about fax + /// Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -89,7 +89,7 @@ public interface IFaxApiSync : IApiAccessor /// Get Fax /// /// - /// Returns information about fax + /// Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -100,11 +100,11 @@ public interface IFaxApiSync : IApiAccessor /// Lists Faxes /// /// - /// Returns properties of multiple faxes + /// Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// FaxListResponse FaxListResponse FaxList(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0); @@ -113,11 +113,11 @@ public interface IFaxApiSync : IApiAccessor /// Lists Faxes /// /// - /// Returns properties of multiple faxes + /// Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// ApiResponse of FaxListResponse ApiResponse FaxListWithHttpInfo(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0); @@ -125,7 +125,7 @@ public interface IFaxApiSync : IApiAccessor /// Send Fax /// /// - /// Action to prepare and send a fax + /// Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -137,7 +137,7 @@ public interface IFaxApiSync : IApiAccessor /// Send Fax /// /// - /// Action to prepare and send a fax + /// Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -157,7 +157,7 @@ public interface IFaxApiAsync : IApiAccessor /// Delete Fax /// /// - /// Deletes the specified Fax from the system. + /// Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -170,7 +170,7 @@ public interface IFaxApiAsync : IApiAccessor /// Delete Fax /// /// - /// Deletes the specified Fax from the system. + /// Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -182,7 +182,7 @@ public interface IFaxApiAsync : IApiAccessor /// Download Fax Files /// /// - /// Downloads fax files + /// Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -195,7 +195,7 @@ public interface IFaxApiAsync : IApiAccessor /// Download Fax Files /// /// - /// Downloads fax files + /// Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -207,7 +207,7 @@ public interface IFaxApiAsync : IApiAccessor /// Get Fax /// /// - /// Returns information about fax + /// Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -220,7 +220,7 @@ public interface IFaxApiAsync : IApiAccessor /// Get Fax /// /// - /// Returns information about fax + /// Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -232,11 +232,11 @@ public interface IFaxApiAsync : IApiAccessor /// Lists Faxes /// /// - /// Returns properties of multiple faxes + /// Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxListResponse @@ -246,11 +246,11 @@ public interface IFaxApiAsync : IApiAccessor /// Lists Faxes /// /// - /// Returns properties of multiple faxes + /// Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxListResponse) @@ -259,7 +259,7 @@ public interface IFaxApiAsync : IApiAccessor /// Send Fax /// /// - /// Action to prepare and send a fax + /// Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -272,7 +272,7 @@ public interface IFaxApiAsync : IApiAccessor /// Send Fax /// /// - /// Action to prepare and send a fax + /// Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -401,7 +401,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory } /// - /// Delete Fax Deletes the specified Fax from the system. + /// Delete Fax Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -413,7 +413,7 @@ public void FaxDelete(string faxId, int operationIndex = 0) } /// - /// Delete Fax Deletes the specified Fax from the system. + /// Delete Fax Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -476,7 +476,7 @@ public Dropbox.Sign.Client.ApiResponse FaxDeleteWithHttpInfo(string faxI } /// - /// Delete Fax Deletes the specified Fax from the system. + /// Delete Fax Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -489,7 +489,7 @@ public Dropbox.Sign.Client.ApiResponse FaxDeleteWithHttpInfo(string faxI } /// - /// Delete Fax Deletes the specified Fax from the system. + /// Delete Fax Deletes the specified Fax from the system /// /// Thrown when fails to make API call /// Fax ID @@ -555,7 +555,7 @@ public Dropbox.Sign.Client.ApiResponse FaxDeleteWithHttpInfo(string faxI } /// - /// Download Fax Files Downloads fax files + /// Download Fax Files Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -568,7 +568,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// Download Fax Files Downloads fax files + /// Download Fax Files Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -632,7 +632,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// Download Fax Files Downloads fax files + /// Download Fax Files Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -646,7 +646,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// Download Fax Files Downloads fax files + /// Download Fax Files Downloads files associated with a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -713,7 +713,7 @@ public System.IO.Stream FaxFiles(string faxId, int operationIndex = 0) } /// - /// Get Fax Returns information about fax + /// Get Fax Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -726,7 +726,7 @@ public FaxGetResponse FaxGet(string faxId, int operationIndex = 0) } /// - /// Get Fax Returns information about fax + /// Get Fax Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -789,7 +789,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Get Fax Returns information about fax + /// Get Fax Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -803,7 +803,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Get Fax Returns information about fax + /// Get Fax Returns information about a Fax /// /// Thrown when fails to make API call /// Fax ID @@ -869,11 +869,11 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Lists Faxes Returns properties of multiple faxes + /// Lists Faxes Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// FaxListResponse public FaxListResponse FaxList(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0) @@ -883,11 +883,11 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Lists Faxes Returns properties of multiple faxes + /// Lists Faxes Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// ApiResponse of FaxListResponse public Dropbox.Sign.Client.ApiResponse FaxListWithHttpInfo(int? page = default(int?), int? pageSize = default(int?), int operationIndex = 0) @@ -948,11 +948,11 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Lists Faxes Returns properties of multiple faxes + /// Lists Faxes Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxListResponse @@ -963,11 +963,11 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Lists Faxes Returns properties of multiple faxes + /// Lists Faxes Returns properties of multiple Faxes /// /// Thrown when fails to make API call - /// Page (optional, default to 1) - /// Page size (optional, default to 20) + /// Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxListResponse) @@ -1031,7 +1031,7 @@ public Dropbox.Sign.Client.ApiResponse FaxGetWithHttpInfo(string } /// - /// Send Fax Action to prepare and send a fax + /// Send Fax Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -1044,7 +1044,7 @@ public FaxGetResponse FaxSend(FaxSendRequest faxSendRequest, int operationIndex } /// - /// Send Fax Action to prepare and send a fax + /// Send Fax Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -1115,7 +1115,7 @@ public Dropbox.Sign.Client.ApiResponse FaxSendWithHttpInfo(FaxSe } /// - /// Send Fax Action to prepare and send a fax + /// Send Fax Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// @@ -1129,7 +1129,7 @@ public Dropbox.Sign.Client.ApiResponse FaxSendWithHttpInfo(FaxSe } /// - /// Send Fax Action to prepare and send a fax + /// Send Fax Creates and sends a new Fax with the submitted file(s) /// /// Thrown when fails to make API call /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs b/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs index 38f303895..127f2e4d7 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Api/FaxLineApi.cs @@ -54,13 +54,13 @@ public interface IFaxLineApiSync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/province and city. + /// Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// FaxLineAreaCodeGetResponse FaxLineAreaCodeGetResponse FaxLineAreaCodeGet(string country, string? state = default(string?), string? province = default(string?), string? city = default(string?), int operationIndex = 0); @@ -69,13 +69,13 @@ public interface IFaxLineApiSync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/province and city. + /// Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// ApiResponse of FaxLineAreaCodeGetResponse ApiResponse FaxLineAreaCodeGetWithHttpInfo(string country, string? state = default(string?), string? province = default(string?), string? city = default(string?), int operationIndex = 0); @@ -83,7 +83,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Purchase Fax Line /// /// - /// Purchases a new Fax Line. + /// Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -95,7 +95,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Purchase Fax Line /// /// - /// Purchases a new Fax Line. + /// Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -132,7 +132,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// FaxLineResponse FaxLineResponse FaxLineGet(string number, int operationIndex = 0); @@ -144,7 +144,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// ApiResponse of FaxLineResponse ApiResponse FaxLineGetWithHttpInfo(string number, int operationIndex = 0); @@ -156,9 +156,9 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// FaxLineListResponse FaxLineListResponse FaxLineList(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), bool? showTeamLines = default(bool?), int operationIndex = 0); @@ -171,9 +171,9 @@ public interface IFaxLineApiSync : IApiAccessor /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// ApiResponse of FaxLineListResponse ApiResponse FaxLineListWithHttpInfo(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), bool? showTeamLines = default(bool?), int operationIndex = 0); @@ -181,7 +181,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Remove Fax Line Access /// /// - /// Removes a user's access to the specified Fax Line. + /// Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -193,7 +193,7 @@ public interface IFaxLineApiSync : IApiAccessor /// Remove Fax Line Access /// /// - /// Removes a user's access to the specified Fax Line. + /// Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -238,13 +238,13 @@ public interface IFaxLineApiAsync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/province and city. + /// Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineAreaCodeGetResponse @@ -254,13 +254,13 @@ public interface IFaxLineApiAsync : IApiAccessor /// Get Available Fax Line Area Codes /// /// - /// Returns a response with the area codes available for a given state/province and city. + /// Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineAreaCodeGetResponse) @@ -269,7 +269,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Purchase Fax Line /// /// - /// Purchases a new Fax Line. + /// Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -282,7 +282,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Purchase Fax Line /// /// - /// Purchases a new Fax Line. + /// Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -322,7 +322,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineResponse @@ -335,7 +335,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineResponse) @@ -348,9 +348,9 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineListResponse @@ -364,9 +364,9 @@ public interface IFaxLineApiAsync : IApiAccessor /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineListResponse) @@ -375,7 +375,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Remove Fax Line Access /// /// - /// Removes a user's access to the specified Fax Line. + /// Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -388,7 +388,7 @@ public interface IFaxLineApiAsync : IApiAccessor /// Remove Fax Line Access /// /// - /// Removes a user's access to the specified Fax Line. + /// Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -689,13 +689,13 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. + /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// FaxLineAreaCodeGetResponse public FaxLineAreaCodeGetResponse FaxLineAreaCodeGet(string country, string? state = default(string?), string? province = default(string?), string? city = default(string?), int operationIndex = 0) @@ -705,13 +705,13 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. + /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// ApiResponse of FaxLineAreaCodeGetResponse public Dropbox.Sign.Client.ApiResponse FaxLineAreaCodeGetWithHttpInfo(string country, string? state = default(string?), string? province = default(string?), string? city = default(string?), int operationIndex = 0) @@ -783,13 +783,13 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. + /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineAreaCodeGetResponse @@ -800,13 +800,13 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Get Available Fax Line Area Codes Returns a response with the area codes available for a given state/province and city. + /// Get Available Fax Line Area Codes Returns a list of available area codes for a given state/province and city /// /// Thrown when fails to make API call - /// Filter area codes by country. - /// Filter area codes by state. (optional) - /// Filter area codes by province. (optional) - /// Filter area codes by city. (optional) + /// Filter area codes by country + /// Filter area codes by state (optional) + /// Filter area codes by province (optional) + /// Filter area codes by city (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineAreaCodeGetResponse) @@ -881,7 +881,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineAddUserWithHttpIn } /// - /// Purchase Fax Line Purchases a new Fax Line. + /// Purchase Fax Line Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -894,7 +894,7 @@ public FaxLineResponse FaxLineCreate(FaxLineCreateRequest faxLineCreateRequest, } /// - /// Purchase Fax Line Purchases a new Fax Line. + /// Purchase Fax Line Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -965,7 +965,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineCreateWithHttpInf } /// - /// Purchase Fax Line Purchases a new Fax Line. + /// Purchase Fax Line Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -979,7 +979,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineCreateWithHttpInf } /// - /// Purchase Fax Line Purchases a new Fax Line. + /// Purchase Fax Line Purchases a new Fax Line /// /// Thrown when fails to make API call /// @@ -1226,7 +1226,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineDeleteWithHttpInfo(FaxLine /// Get Fax Line Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// FaxLineResponse public FaxLineResponse FaxLineGet(string number, int operationIndex = 0) @@ -1239,7 +1239,7 @@ public FaxLineResponse FaxLineGet(string number, int operationIndex = 0) /// Get Fax Line Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// ApiResponse of FaxLineResponse public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(string number, int operationIndex = 0) @@ -1302,7 +1302,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// Get Fax Line Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineResponse @@ -1316,7 +1316,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// Get Fax Line Returns the properties and settings of a Fax Line. /// /// Thrown when fails to make API call - /// The Fax Line number. + /// The Fax Line number /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineResponse) @@ -1383,9 +1383,9 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// FaxLineListResponse public FaxLineListResponse FaxLineList(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), bool? showTeamLines = default(bool?), int operationIndex = 0) @@ -1399,9 +1399,9 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// ApiResponse of FaxLineListResponse public Dropbox.Sign.Client.ApiResponse FaxLineListWithHttpInfo(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), bool? showTeamLines = default(bool?), int operationIndex = 0) @@ -1474,9 +1474,9 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of FaxLineListResponse @@ -1491,9 +1491,9 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s /// /// Thrown when fails to make API call /// Account ID (optional) - /// Page (optional, default to 1) - /// Page size (optional, default to 20) - /// Show team lines (optional) + /// Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + /// Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + /// Include Fax Lines belonging to team members in the list (optional) /// Index associated with the operation. /// Cancellation Token to cancel the request. /// Task of ApiResponse (FaxLineListResponse) @@ -1565,7 +1565,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineGetWithHttpInfo(s } /// - /// Remove Fax Line Access Removes a user's access to the specified Fax Line. + /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -1578,7 +1578,7 @@ public FaxLineResponse FaxLineRemoveUser(FaxLineRemoveUserRequest faxLineRemoveU } /// - /// Remove Fax Line Access Removes a user's access to the specified Fax Line. + /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -1649,7 +1649,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineRemoveUserWithHtt } /// - /// Remove Fax Line Access Removes a user's access to the specified Fax Line. + /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// @@ -1663,7 +1663,7 @@ public Dropbox.Sign.Client.ApiResponse FaxLineRemoveUserWithHtt } /// - /// Remove Fax Line Access Removes a user's access to the specified Fax Line. + /// Remove Fax Line Access Removes a user's access to the specified Fax Line /// /// Thrown when fails to make API call /// diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineAddUserRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineAddUserRequest.cs index 55509a4bc..fbbc7084e 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineAddUserRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineAddUserRequest.cs @@ -41,7 +41,7 @@ protected FaxLineAddUserRequest() { } /// /// Initializes a new instance of the class. /// - /// The Fax Line number. (required). + /// The Fax Line number (required). /// Account ID. /// Email address. public FaxLineAddUserRequest(string number = default(string), string accountId = default(string), string emailAddress = default(string)) @@ -74,9 +74,9 @@ public static FaxLineAddUserRequest Init(string jsonData) } /// - /// The Fax Line number. + /// The Fax Line number /// - /// The Fax Line number. + /// The Fax Line number [DataMember(Name = "number", IsRequired = true, EmitDefaultValue = true)] public string Number { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineCreateRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineCreateRequest.cs index 733cab7f8..ad5c88445 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineCreateRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineCreateRequest.cs @@ -34,9 +34,9 @@ namespace Dropbox.Sign.Model public partial class FaxLineCreateRequest : IEquatable, IValidatableObject { /// - /// Country + /// Country of the area code /// - /// Country + /// Country of the area code [JsonConverter(typeof(StringEnumConverter))] public enum CountryEnum { @@ -61,9 +61,9 @@ public enum CountryEnum /// - /// Country + /// Country of the area code /// - /// Country + /// Country of the area code [DataMember(Name = "country", IsRequired = true, EmitDefaultValue = true)] public CountryEnum Country { get; set; } /// @@ -74,10 +74,10 @@ protected FaxLineCreateRequest() { } /// /// Initializes a new instance of the class. /// - /// Area code (required). - /// Country (required). - /// City. - /// Account ID. + /// Area code of the new Fax Line (required). + /// Country of the area code (required). + /// City of the area code. + /// Account ID of the account that will be assigned this new Fax Line. public FaxLineCreateRequest(int areaCode = default(int), CountryEnum country = default(CountryEnum), string city = default(string), string accountId = default(string)) { @@ -104,23 +104,23 @@ public static FaxLineCreateRequest Init(string jsonData) } /// - /// Area code + /// Area code of the new Fax Line /// - /// Area code + /// Area code of the new Fax Line [DataMember(Name = "area_code", IsRequired = true, EmitDefaultValue = true)] public int AreaCode { get; set; } /// - /// City + /// City of the area code /// - /// City + /// City of the area code [DataMember(Name = "city", EmitDefaultValue = true)] public string City { get; set; } /// - /// Account ID + /// Account ID of the account that will be assigned this new Fax Line /// - /// Account ID + /// Account ID of the account that will be assigned this new Fax Line /// ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 [DataMember(Name = "account_id", EmitDefaultValue = true)] public string AccountId { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineDeleteRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineDeleteRequest.cs index cb5a27378..5bc3e961d 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineDeleteRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineDeleteRequest.cs @@ -41,7 +41,7 @@ protected FaxLineDeleteRequest() { } /// /// Initializes a new instance of the class. /// - /// The Fax Line number. (required). + /// The Fax Line number (required). public FaxLineDeleteRequest(string number = default(string)) { @@ -70,9 +70,9 @@ public static FaxLineDeleteRequest Init(string jsonData) } /// - /// The Fax Line number. + /// The Fax Line number /// - /// The Fax Line number. + /// The Fax Line number [DataMember(Name = "number", IsRequired = true, EmitDefaultValue = true)] public string Number { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineRemoveUserRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineRemoveUserRequest.cs index eed6d36a9..1347d8250 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineRemoveUserRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxLineRemoveUserRequest.cs @@ -41,9 +41,9 @@ protected FaxLineRemoveUserRequest() { } /// /// Initializes a new instance of the class. /// - /// The Fax Line number. (required). - /// Account ID. - /// Email address. + /// The Fax Line number (required). + /// Account ID of the user to remove access. + /// Email address of the user to remove access. public FaxLineRemoveUserRequest(string number = default(string), string accountId = default(string), string emailAddress = default(string)) { @@ -74,24 +74,24 @@ public static FaxLineRemoveUserRequest Init(string jsonData) } /// - /// The Fax Line number. + /// The Fax Line number /// - /// The Fax Line number. + /// The Fax Line number [DataMember(Name = "number", IsRequired = true, EmitDefaultValue = true)] public string Number { get; set; } /// - /// Account ID + /// Account ID of the user to remove access /// - /// Account ID + /// Account ID of the user to remove access /// ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 [DataMember(Name = "account_id", EmitDefaultValue = true)] public string AccountId { get; set; } /// - /// Email address + /// Email address of the user to remove access /// - /// Email address + /// Email address of the user to remove access [DataMember(Name = "email_address", EmitDefaultValue = true)] public string EmailAddress { get; set; } diff --git a/sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs b/sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs index e4d42e6d4..d5eddb1b5 100644 --- a/sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs +++ b/sdks/dotnet/src/Dropbox.Sign/Model/FaxSendRequest.cs @@ -41,13 +41,13 @@ protected FaxSendRequest() { } /// /// Initializes a new instance of the class. /// - /// Fax Send To Recipient (required). + /// Recipient of the fax Can be a phone number in E.164 format or email address (required). /// Fax Send From Sender (used only with fax number). - /// Fax File to Send. - /// Fax File URL to Send. + /// Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both.. + /// Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both.. /// API Test Mode Setting (default to false). - /// Fax Cover Page for Recipient. - /// Fax Cover Page for Sender. + /// Fax cover page recipient information. + /// Fax cover page sender information. /// Fax Cover Page Message. /// Fax Title. public FaxSendRequest(string recipient = default(string), string sender = default(string), List files = default(List), List fileUrls = default(List), bool testMode = false, string coverPageTo = default(string), string coverPageFrom = default(string), string coverPageMessage = default(string), string title = default(string)) @@ -86,9 +86,9 @@ public static FaxSendRequest Init(string jsonData) } /// - /// Fax Send To Recipient + /// Recipient of the fax Can be a phone number in E.164 format or email address /// - /// Fax Send To Recipient + /// Recipient of the fax Can be a phone number in E.164 format or email address /// recipient@example.com [DataMember(Name = "recipient", IsRequired = true, EmitDefaultValue = true)] public string Recipient { get; set; } @@ -102,16 +102,16 @@ public static FaxSendRequest Init(string jsonData) public string Sender { get; set; } /// - /// Fax File to Send + /// Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. /// - /// Fax File to Send + /// Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. [DataMember(Name = "files", EmitDefaultValue = true)] public List Files { get; set; } /// - /// Fax File URL to Send + /// Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. /// - /// Fax File URL to Send + /// Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. [DataMember(Name = "file_urls", EmitDefaultValue = true)] public List FileUrls { get; set; } @@ -123,17 +123,17 @@ public static FaxSendRequest Init(string jsonData) public bool TestMode { get; set; } /// - /// Fax Cover Page for Recipient + /// Fax cover page recipient information /// - /// Fax Cover Page for Recipient + /// Fax cover page recipient information /// Recipient Name [DataMember(Name = "cover_page_to", EmitDefaultValue = true)] public string CoverPageTo { get; set; } /// - /// Fax Cover Page for Sender + /// Fax cover page sender information /// - /// Fax Cover Page for Sender + /// Fax cover page sender information /// Sender Name [DataMember(Name = "cover_page_from", EmitDefaultValue = true)] public string CoverPageFrom { get; set; } diff --git a/sdks/java-v1/docs/FaxApi.md b/sdks/java-v1/docs/FaxApi.md index 16102c5a4..5166ea29c 100644 --- a/sdks/java-v1/docs/FaxApi.md +++ b/sdks/java-v1/docs/FaxApi.md @@ -18,7 +18,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example @@ -84,7 +84,7 @@ null (empty response body) Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Example @@ -153,7 +153,7 @@ public class Example { Get Fax -Returns information about fax +Returns information about a Fax ### Example @@ -221,7 +221,7 @@ public class Example { Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example @@ -262,8 +262,8 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **page** | **Integer**| Page | [optional] [default to 1] - **pageSize** | **Integer**| Page size | [optional] [default to 20] + **page** | **Integer**| Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] + **pageSize** | **Integer**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] ### Return type @@ -291,7 +291,7 @@ public class Example { Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example diff --git a/sdks/java-v1/docs/FaxLineAddUserRequest.md b/sdks/java-v1/docs/FaxLineAddUserRequest.md index 1c9e997f9..4023bd024 100644 --- a/sdks/java-v1/docs/FaxLineAddUserRequest.md +++ b/sdks/java-v1/docs/FaxLineAddUserRequest.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | | `accountId` | ```String``` | Account ID | | | `emailAddress` | ```String``` | Email address | | diff --git a/sdks/java-v1/docs/FaxLineApi.md b/sdks/java-v1/docs/FaxLineApi.md index 3aa4f8c4c..418bfc558 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/province and city. +Returns a list of available area codes for a given state/province and city ### Example @@ -130,10 +130,10 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **country** | **String**| Filter area codes by country. | [enum: CA, US, UK] - **state** | **String**| Filter area codes by state. | [optional] [enum: AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY] - **province** | **String**| Filter area codes by province. | [optional] [enum: AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT] - **city** | **String**| Filter area codes by city. | [optional] + **country** | **String**| Filter area codes by country | [enum: CA, US, UK] + **state** | **String**| Filter area codes by state | [optional] [enum: AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY] + **province** | **String**| Filter area codes by province | [optional] [enum: AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT] + **city** | **String**| Filter area codes by city | [optional] ### Return type @@ -161,7 +161,7 @@ public class Example { Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example @@ -340,7 +340,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **number** | **String**| The Fax Line number. | + **number** | **String**| The Fax Line number | ### Return type @@ -408,9 +408,9 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| **accountId** | **String**| Account ID | [optional] - **page** | **Integer**| Page | [optional] [default to 1] - **pageSize** | **Integer**| Page size | [optional] [default to 20] - **showTeamLines** | **Boolean**| Show team lines | [optional] + **page** | **Integer**| Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] + **pageSize** | **Integer**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] + **showTeamLines** | **Boolean**| Include Fax Lines belonging to team members in the list | [optional] ### Return type @@ -438,7 +438,7 @@ public class Example { Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example diff --git a/sdks/java-v1/docs/FaxLineCreateRequest.md b/sdks/java-v1/docs/FaxLineCreateRequest.md index da9ba3953..7fd1be6bf 100644 --- a/sdks/java-v1/docs/FaxLineCreateRequest.md +++ b/sdks/java-v1/docs/FaxLineCreateRequest.md @@ -8,10 +8,10 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `areaCode`*_required_ | ```Integer``` | Area code | | -| `country`*_required_ | [```CountryEnum```](#CountryEnum) | Country | | -| `city` | ```String``` | City | | -| `accountId` | ```String``` | Account ID | | +| `areaCode`*_required_ | ```Integer``` | Area code of the new Fax Line | | +| `country`*_required_ | [```CountryEnum```](#CountryEnum) | Country of the area code | | +| `city` | ```String``` | City of the area code | | +| `accountId` | ```String``` | Account ID of the account that will be assigned this new Fax Line | | diff --git a/sdks/java-v1/docs/FaxLineDeleteRequest.md b/sdks/java-v1/docs/FaxLineDeleteRequest.md index de1748fa1..4b45b339f 100644 --- a/sdks/java-v1/docs/FaxLineDeleteRequest.md +++ b/sdks/java-v1/docs/FaxLineDeleteRequest.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | diff --git a/sdks/java-v1/docs/FaxLineRemoveUserRequest.md b/sdks/java-v1/docs/FaxLineRemoveUserRequest.md index 51d81b8fa..8e55d572d 100644 --- a/sdks/java-v1/docs/FaxLineRemoveUserRequest.md +++ b/sdks/java-v1/docs/FaxLineRemoveUserRequest.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | -| `accountId` | ```String``` | Account ID | | -| `emailAddress` | ```String``` | Email address | | +| `number`*_required_ | ```String``` | The Fax Line number | | +| `accountId` | ```String``` | Account ID of the user to remove access | | +| `emailAddress` | ```String``` | Email address of the user to remove access | | diff --git a/sdks/java-v1/docs/FaxSendRequest.md b/sdks/java-v1/docs/FaxSendRequest.md index 5b939a0af..65b105756 100644 --- a/sdks/java-v1/docs/FaxSendRequest.md +++ b/sdks/java-v1/docs/FaxSendRequest.md @@ -8,13 +8,13 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `recipient`*_required_ | ```String``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```String``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```String``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```List``` | Fax File to Send | | -| `fileUrls` | ```List``` | Fax File URL to Send | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `testMode` | ```Boolean``` | API Test Mode Setting | | -| `coverPageTo` | ```String``` | Fax Cover Page for Recipient | | -| `coverPageFrom` | ```String``` | Fax Cover Page for Sender | | +| `coverPageTo` | ```String``` | Fax cover page recipient information | | +| `coverPageFrom` | ```String``` | Fax cover page sender information | | | `coverPageMessage` | ```String``` | Fax Cover Page Message | | | `title` | ```String``` | Fax Title | | 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 bf79b4f83..9e0041637 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 @@ -49,7 +49,7 @@ public void setApiClient(ApiClient apiClient) { } /** - * Delete Fax. Deletes the specified Fax from the system. + * Delete Fax. Deletes the specified Fax from the system * * @param faxId Fax ID (required) * @throws ApiException if fails to make API call @@ -65,7 +65,7 @@ public void faxDelete(String faxId) throws ApiException { } /** - * Delete Fax. Deletes the specified Fax from the system. + * Delete Fax. Deletes the specified Fax from the system * * @param faxId Fax ID (required) * @return ApiResponse<Void> @@ -113,7 +113,7 @@ public ApiResponse faxDeleteWithHttpInfo(String faxId) throws ApiException } /** - * Download Fax Files. Downloads fax files + * Download Fax Files. Downloads files associated with a Fax * * @param faxId Fax ID (required) * @return File @@ -130,7 +130,7 @@ public File faxFiles(String faxId) throws ApiException { } /** - * Download Fax Files. Downloads fax files + * Download Fax Files. Downloads files associated with a Fax * * @param faxId Fax ID (required) * @return ApiResponse<File> @@ -180,7 +180,7 @@ public ApiResponse faxFilesWithHttpInfo(String faxId) throws ApiException } /** - * Get Fax. Returns information about fax + * Get Fax. Returns information about a Fax * * @param faxId Fax ID (required) * @return FaxGetResponse @@ -197,7 +197,7 @@ public FaxGetResponse faxGet(String faxId) throws ApiException { } /** - * Get Fax. Returns information about fax + * Get Fax. Returns information about a Fax * * @param faxId Fax ID (required) * @return ApiResponse<FaxGetResponse> @@ -246,10 +246,12 @@ public ApiResponse faxGetWithHttpInfo(String faxId) throws ApiEx } /** - * Lists Faxes. Returns properties of multiple faxes + * Lists Faxes. Returns properties of multiple Faxes * - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) + * @param page Which page number of the Fax List to return. Defaults to `1`. + * (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and + * `100`. Default is `20`. (optional, default to 20) * @return FaxListResponse * @throws ApiException if fails to make API call * @http.response.details @@ -302,10 +304,12 @@ public ApiResponse faxListWithHttpInfo(Integer page) throws Api } /** - * Lists Faxes. Returns properties of multiple faxes + * Lists Faxes. Returns properties of multiple Faxes * - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) + * @param page Which page number of the Fax List to return. Defaults to `1`. + * (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and + * `100`. Default is `20`. (optional, default to 20) * @return ApiResponse<FaxListResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -354,7 +358,7 @@ public ApiResponse faxListWithHttpInfo(Integer page, Integer pa } /** - * Send Fax. Action to prepare and send a fax + * Send Fax. Creates and sends a new Fax with the submitted file(s) * * @param faxSendRequest (required) * @return FaxGetResponse @@ -371,7 +375,7 @@ public FaxGetResponse faxSend(FaxSendRequest faxSendRequest) throws ApiException } /** - * Send Fax. Action to prepare and send a fax + * Send Fax. Creates and sends a new Fax with the submitted file(s) * * @param faxSendRequest (required) * @return ApiResponse<FaxGetResponse> 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 6f35fb7aa..e8736ad65 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 @@ -120,13 +120,13 @@ public ApiResponse faxLineAddUserWithHttpInfo( } /** - * Get Available Fax Line Area Codes. Returns a response with the area codes available for a - * given state/province and city. + * Get Available Fax Line Area Codes. Returns a list of available area codes 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) - * @param city Filter area codes by city. (optional) + * @param country Filter area codes by country (required) + * @param state Filter area codes by state (optional) + * @param province Filter area codes by province (optional) + * @param city Filter area codes by city (optional) * @return FaxLineAreaCodeGetResponse * @throws ApiException if fails to make API call * @http.response.details @@ -207,13 +207,13 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo( } /** - * Get Available Fax Line Area Codes. Returns a response with the area codes available for a - * given state/province and city. + * Get Available Fax Line Area Codes. Returns a list of available area codes 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) - * @param city Filter area codes by city. (optional) + * @param country Filter area codes by country (required) + * @param state Filter area codes by state (optional) + * @param province Filter area codes by province (optional) + * @param city Filter area codes by city (optional) * @return ApiResponse<FaxLineAreaCodeGetResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -266,7 +266,7 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo( } /** - * Purchase Fax Line. Purchases a new Fax Line. + * Purchase Fax Line. Purchases a new Fax Line * * @param faxLineCreateRequest (required) * @return FaxLineResponse @@ -284,7 +284,7 @@ public FaxLineResponse faxLineCreate(FaxLineCreateRequest faxLineCreateRequest) } /** - * Purchase Fax Line. Purchases a new Fax Line. + * Purchase Fax Line. Purchases a new Fax Line * * @param faxLineCreateRequest (required) * @return ApiResponse<FaxLineResponse> @@ -401,7 +401,7 @@ public ApiResponse faxLineDeleteWithHttpInfo(FaxLineDeleteRequest faxLineD /** * Get Fax Line. Returns the properties and settings of a Fax Line. * - * @param number The Fax Line number. (required) + * @param number The Fax Line number (required) * @return FaxLineResponse * @throws ApiException if fails to make API call * @http.response.details @@ -418,7 +418,7 @@ public FaxLineResponse faxLineGet(String number) throws ApiException { /** * Get Fax Line. Returns the properties and settings of a Fax Line. * - * @param number The Fax Line number. (required) + * @param number The Fax Line number (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -468,9 +468,11 @@ public ApiResponse faxLineGetWithHttpInfo(String number) throws * List Fax Lines. Returns the properties and settings of multiple Fax Lines. * * @param accountId Account ID (optional) - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) - * @param showTeamLines Show team lines (optional) + * @param page Which page number of the Fax Line List to return. Defaults to `1`. + * (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and + * `100`. Default is `20`. (optional, default to 20) + * @param showTeamLines Include Fax Lines belonging to team members in the list (optional) * @return FaxLineListResponse * @throws ApiException if fails to make API call * @http.response.details @@ -578,9 +580,11 @@ public ApiResponse faxLineListWithHttpInfo( * List Fax Lines. Returns the properties and settings of multiple Fax Lines. * * @param accountId Account ID (optional) - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) - * @param showTeamLines Show team lines (optional) + * @param page Which page number of the Fax Line List to return. Defaults to `1`. + * (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and + * `100`. Default is `20`. (optional, default to 20) + * @param showTeamLines Include Fax Lines belonging to team members in the list (optional) * @return ApiResponse<FaxLineListResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -634,7 +638,7 @@ public ApiResponse faxLineListWithHttpInfo( } /** - * Remove Fax Line Access. Removes a user's access to the specified Fax Line. + * Remove Fax Line Access. Removes a user's access to the specified Fax Line * * @param faxLineRemoveUserRequest (required) * @return FaxLineResponse @@ -652,7 +656,7 @@ public FaxLineResponse faxLineRemoveUser(FaxLineRemoveUserRequest faxLineRemoveU } /** - * Remove Fax Line Access. Removes a user's access to the specified Fax Line. + * Remove Fax Line Access. Removes a user's access to the specified Fax Line * * @param faxLineRemoveUserRequest (required) * @return ApiResponse<FaxLineResponse> diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java index f1d852493..d86167c2e 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java @@ -66,7 +66,7 @@ public FaxLineAddUserRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * * @return number */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java index 7f18d7bc7..e75ea0d36 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java @@ -40,7 +40,7 @@ public class FaxLineCreateRequest { public static final String JSON_PROPERTY_AREA_CODE = "area_code"; private Integer areaCode; - /** Country */ + /** Country of the area code */ public enum CountryEnum { CA("CA"), @@ -106,7 +106,7 @@ public FaxLineCreateRequest areaCode(Integer areaCode) { } /** - * Area code + * Area code of the new Fax Line * * @return areaCode */ @@ -129,7 +129,7 @@ public FaxLineCreateRequest country(CountryEnum country) { } /** - * Country + * Country of the area code * * @return country */ @@ -152,7 +152,7 @@ public FaxLineCreateRequest city(String city) { } /** - * City + * City of the area code * * @return city */ @@ -174,7 +174,7 @@ public FaxLineCreateRequest accountId(String accountId) { } /** - * Account ID + * Account ID of the account that will be assigned this new Fax Line * * @return accountId */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java index 7a7bfdd5f..efd21bff3 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java @@ -55,7 +55,7 @@ public FaxLineDeleteRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * * @return number */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java index 0347f5886..14d15e0bd 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java @@ -67,7 +67,7 @@ public FaxLineRemoveUserRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * * @return number */ @@ -90,7 +90,7 @@ public FaxLineRemoveUserRequest accountId(String accountId) { } /** - * Account ID + * Account ID of the user to remove access * * @return accountId */ @@ -112,7 +112,7 @@ public FaxLineRemoveUserRequest emailAddress(String emailAddress) { } /** - * Email address + * Email address of the user to remove access * * @return emailAddress */ diff --git a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java index 571ba92f8..b668e9ff7 100644 --- a/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java +++ b/sdks/java-v1/src/main/java/com/dropbox/sign/model/FaxSendRequest.java @@ -92,7 +92,7 @@ public FaxSendRequest recipient(String recipient) { } /** - * Fax Send To Recipient + * Recipient of the fax Can be a phone number in E.164 format or email address * * @return recipient */ @@ -145,7 +145,8 @@ public FaxSendRequest addFilesItem(File filesItem) { } /** - * Fax File to Send + * Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either + * **files** or **file_urls[]**, but not both. * * @return files */ @@ -175,7 +176,8 @@ public FaxSendRequest addFileUrlsItem(String fileUrlsItem) { } /** - * Fax File URL to Send + * Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint + * requires either **files** or **file_urls[]**, but not both. * * @return fileUrls */ @@ -219,7 +221,7 @@ public FaxSendRequest coverPageTo(String coverPageTo) { } /** - * Fax Cover Page for Recipient + * Fax cover page recipient information * * @return coverPageTo */ @@ -241,7 +243,7 @@ public FaxSendRequest coverPageFrom(String coverPageFrom) { } /** - * Fax Cover Page for Sender + * Fax cover page sender information * * @return coverPageFrom */ diff --git a/sdks/java-v2/docs/FaxApi.md b/sdks/java-v2/docs/FaxApi.md index 16102c5a4..5166ea29c 100644 --- a/sdks/java-v2/docs/FaxApi.md +++ b/sdks/java-v2/docs/FaxApi.md @@ -18,7 +18,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example @@ -84,7 +84,7 @@ null (empty response body) Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Example @@ -153,7 +153,7 @@ public class Example { Get Fax -Returns information about fax +Returns information about a Fax ### Example @@ -221,7 +221,7 @@ public class Example { Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example @@ -262,8 +262,8 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **page** | **Integer**| Page | [optional] [default to 1] - **pageSize** | **Integer**| Page size | [optional] [default to 20] + **page** | **Integer**| Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] + **pageSize** | **Integer**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] ### Return type @@ -291,7 +291,7 @@ public class Example { Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example diff --git a/sdks/java-v2/docs/FaxLineAddUserRequest.md b/sdks/java-v2/docs/FaxLineAddUserRequest.md index 1c9e997f9..4023bd024 100644 --- a/sdks/java-v2/docs/FaxLineAddUserRequest.md +++ b/sdks/java-v2/docs/FaxLineAddUserRequest.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | | `accountId` | ```String``` | Account ID | | | `emailAddress` | ```String``` | Email address | | diff --git a/sdks/java-v2/docs/FaxLineApi.md b/sdks/java-v2/docs/FaxLineApi.md index 3aa4f8c4c..418bfc558 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/province and city. +Returns a list of available area codes for a given state/province and city ### Example @@ -130,10 +130,10 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **country** | **String**| Filter area codes by country. | [enum: CA, US, UK] - **state** | **String**| Filter area codes by state. | [optional] [enum: AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY] - **province** | **String**| Filter area codes by province. | [optional] [enum: AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT] - **city** | **String**| Filter area codes by city. | [optional] + **country** | **String**| Filter area codes by country | [enum: CA, US, UK] + **state** | **String**| Filter area codes by state | [optional] [enum: AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY] + **province** | **String**| Filter area codes by province | [optional] [enum: AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT] + **city** | **String**| Filter area codes by city | [optional] ### Return type @@ -161,7 +161,7 @@ public class Example { Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example @@ -340,7 +340,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **number** | **String**| The Fax Line number. | + **number** | **String**| The Fax Line number | ### Return type @@ -408,9 +408,9 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| **accountId** | **String**| Account ID | [optional] - **page** | **Integer**| Page | [optional] [default to 1] - **pageSize** | **Integer**| Page size | [optional] [default to 20] - **showTeamLines** | **Boolean**| Show team lines | [optional] + **page** | **Integer**| Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] + **pageSize** | **Integer**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] + **showTeamLines** | **Boolean**| Include Fax Lines belonging to team members in the list | [optional] ### Return type @@ -438,7 +438,7 @@ public class Example { Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example diff --git a/sdks/java-v2/docs/FaxLineCreateRequest.md b/sdks/java-v2/docs/FaxLineCreateRequest.md index da9ba3953..7fd1be6bf 100644 --- a/sdks/java-v2/docs/FaxLineCreateRequest.md +++ b/sdks/java-v2/docs/FaxLineCreateRequest.md @@ -8,10 +8,10 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `areaCode`*_required_ | ```Integer``` | Area code | | -| `country`*_required_ | [```CountryEnum```](#CountryEnum) | Country | | -| `city` | ```String``` | City | | -| `accountId` | ```String``` | Account ID | | +| `areaCode`*_required_ | ```Integer``` | Area code of the new Fax Line | | +| `country`*_required_ | [```CountryEnum```](#CountryEnum) | Country of the area code | | +| `city` | ```String``` | City of the area code | | +| `accountId` | ```String``` | Account ID of the account that will be assigned this new Fax Line | | diff --git a/sdks/java-v2/docs/FaxLineDeleteRequest.md b/sdks/java-v2/docs/FaxLineDeleteRequest.md index de1748fa1..4b45b339f 100644 --- a/sdks/java-v2/docs/FaxLineDeleteRequest.md +++ b/sdks/java-v2/docs/FaxLineDeleteRequest.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | diff --git a/sdks/java-v2/docs/FaxLineRemoveUserRequest.md b/sdks/java-v2/docs/FaxLineRemoveUserRequest.md index 51d81b8fa..8e55d572d 100644 --- a/sdks/java-v2/docs/FaxLineRemoveUserRequest.md +++ b/sdks/java-v2/docs/FaxLineRemoveUserRequest.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | -| `accountId` | ```String``` | Account ID | | -| `emailAddress` | ```String``` | Email address | | +| `number`*_required_ | ```String``` | The Fax Line number | | +| `accountId` | ```String``` | Account ID of the user to remove access | | +| `emailAddress` | ```String``` | Email address of the user to remove access | | diff --git a/sdks/java-v2/docs/FaxSendRequest.md b/sdks/java-v2/docs/FaxSendRequest.md index 5b939a0af..65b105756 100644 --- a/sdks/java-v2/docs/FaxSendRequest.md +++ b/sdks/java-v2/docs/FaxSendRequest.md @@ -8,13 +8,13 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `recipient`*_required_ | ```String``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```String``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```String``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```List``` | Fax File to Send | | -| `fileUrls` | ```List``` | Fax File URL to Send | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `testMode` | ```Boolean``` | API Test Mode Setting | | -| `coverPageTo` | ```String``` | Fax Cover Page for Recipient | | -| `coverPageFrom` | ```String``` | Fax Cover Page for Sender | | +| `coverPageTo` | ```String``` | Fax cover page recipient information | | +| `coverPageFrom` | ```String``` | Fax cover page sender information | | | `coverPageMessage` | ```String``` | Fax Cover Page Message | | | `title` | ```String``` | Fax Title | | 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 a42076f38..2bb22a100 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 @@ -52,7 +52,7 @@ public void setApiClient(ApiClient apiClient) { /** * Delete Fax. - * Deletes the specified Fax from the system. + * Deletes the specified Fax from the system * @param faxId Fax ID (required) * @throws ApiException if fails to make API call * @http.response.details @@ -69,7 +69,7 @@ public void faxDelete(String faxId) throws ApiException { /** * Delete Fax. - * Deletes the specified Fax from the system. + * Deletes the specified Fax from the system * @param faxId Fax ID (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call @@ -115,7 +115,7 @@ public ApiResponse faxDeleteWithHttpInfo(String faxId) throws ApiException } /** * Download Fax Files. - * Downloads fax files + * Downloads files associated with a Fax * @param faxId Fax ID (required) * @return File * @throws ApiException if fails to make API call @@ -133,7 +133,7 @@ public File faxFiles(String faxId) throws ApiException { /** * Download Fax Files. - * Downloads fax files + * Downloads files associated with a Fax * @param faxId Fax ID (required) * @return ApiResponse<File> * @throws ApiException if fails to make API call @@ -180,7 +180,7 @@ public ApiResponse faxFilesWithHttpInfo(String faxId) throws ApiException } /** * Get Fax. - * Returns information about fax + * Returns information about a Fax * @param faxId Fax ID (required) * @return FaxGetResponse * @throws ApiException if fails to make API call @@ -198,7 +198,7 @@ public FaxGetResponse faxGet(String faxId) throws ApiException { /** * Get Fax. - * Returns information about fax + * Returns information about a Fax * @param faxId Fax ID (required) * @return ApiResponse<FaxGetResponse> * @throws ApiException if fails to make API call @@ -245,9 +245,9 @@ public ApiResponse faxGetWithHttpInfo(String faxId) throws ApiEx } /** * Lists Faxes. - * Returns properties of multiple faxes - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) + * Returns properties of multiple Faxes + * @param page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @return FaxListResponse * @throws ApiException if fails to make API call * @http.response.details @@ -303,9 +303,9 @@ public ApiResponse faxListWithHttpInfo(Integer page) throws Api /** * Lists Faxes. - * Returns properties of multiple faxes - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) + * Returns properties of multiple Faxes + * @param page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @return ApiResponse<FaxListResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -354,7 +354,7 @@ public ApiResponse faxListWithHttpInfo(Integer page, Integer pa } /** * Send Fax. - * Action to prepare and send a fax + * Creates and sends a new Fax with the submitted file(s) * @param faxSendRequest (required) * @return FaxGetResponse * @throws ApiException if fails to make API call @@ -372,7 +372,7 @@ public FaxGetResponse faxSend(FaxSendRequest faxSendRequest) throws ApiException /** * Send Fax. - * Action to prepare and send a fax + * Creates and sends a new Fax with the submitted file(s) * @param faxSendRequest (required) * @return ApiResponse<FaxGetResponse> * @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 c6d9a5eea..53d1a3bbc 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,11 +116,11 @@ public ApiResponse faxLineAddUserWithHttpInfo(FaxLineAddUserReq } /** * Get Available Fax Line Area Codes. - * 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) - * @param city Filter area codes by city. (optional) + * Returns a list of available area codes 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) + * @param city Filter area codes by city (optional) * @return FaxLineAreaCodeGetResponse * @throws ApiException if fails to make API call * @http.response.details @@ -198,11 +198,11 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo(St /** * Get Available Fax Line Area Codes. - * 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) - * @param city Filter area codes by city. (optional) + * Returns a list of available area codes 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) + * @param city Filter area codes by city (optional) * @return ApiResponse<FaxLineAreaCodeGetResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -252,7 +252,7 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo(St } /** * Purchase Fax Line. - * Purchases a new Fax Line. + * Purchases a new Fax Line * @param faxLineCreateRequest (required) * @return FaxLineResponse * @throws ApiException if fails to make API call @@ -270,7 +270,7 @@ public FaxLineResponse faxLineCreate(FaxLineCreateRequest faxLineCreateRequest) /** * Purchase Fax Line. - * Purchases a new Fax Line. + * Purchases a new Fax Line * @param faxLineCreateRequest (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call @@ -373,7 +373,7 @@ public ApiResponse faxLineDeleteWithHttpInfo(FaxLineDeleteRequest faxLineD /** * Get Fax Line. * Returns the properties and settings of a Fax Line. - * @param number The Fax Line number. (required) + * @param number The Fax Line number (required) * @return FaxLineResponse * @throws ApiException if fails to make API call * @http.response.details @@ -391,7 +391,7 @@ public FaxLineResponse faxLineGet(String number) throws ApiException { /** * Get Fax Line. * Returns the properties and settings of a Fax Line. - * @param number The Fax Line number. (required) + * @param number The Fax Line number (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -440,9 +440,9 @@ public ApiResponse faxLineGetWithHttpInfo(String number) throws * List Fax Lines. * Returns the properties and settings of multiple Fax Lines. * @param accountId Account ID (optional) - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) - * @param showTeamLines Show team lines (optional) + * @param page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param showTeamLines Include Fax Lines belonging to team members in the list (optional) * @return FaxLineListResponse * @throws ApiException if fails to make API call * @http.response.details @@ -546,9 +546,9 @@ public ApiResponse faxLineListWithHttpInfo(String accountId * List Fax Lines. * Returns the properties and settings of multiple Fax Lines. * @param accountId Account ID (optional) - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) - * @param showTeamLines Show team lines (optional) + * @param page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param showTeamLines Include Fax Lines belonging to team members in the list (optional) * @return ApiResponse<FaxLineListResponse> * @throws ApiException if fails to make API call * @http.response.details @@ -599,7 +599,7 @@ public ApiResponse faxLineListWithHttpInfo(String accountId } /** * Remove Fax Line Access. - * Removes a user's access to the specified Fax Line. + * Removes a user's access to the specified Fax Line * @param faxLineRemoveUserRequest (required) * @return FaxLineResponse * @throws ApiException if fails to make API call @@ -617,7 +617,7 @@ public FaxLineResponse faxLineRemoveUser(FaxLineRemoveUserRequest faxLineRemoveU /** * Remove Fax Line Access. - * Removes a user's access to the specified Fax Line. + * Removes a user's access to the specified Fax Line * @param faxLineRemoveUserRequest (required) * @return ApiResponse<FaxLineResponse> * @throws ApiException if fails to make API call diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java index 99f972a27..a4d24fbea 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java @@ -73,7 +73,7 @@ public FaxLineAddUserRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * @return number */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java index 7d23eac13..c05bde435 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java @@ -45,7 +45,7 @@ public class FaxLineCreateRequest { private Integer areaCode; /** - * Country + * Country of the area code */ public enum CountryEnum { CA("CA"), @@ -114,7 +114,7 @@ public FaxLineCreateRequest areaCode(Integer areaCode) { } /** - * Area code + * Area code of the new Fax Line * @return areaCode */ @jakarta.annotation.Nonnull @@ -139,7 +139,7 @@ public FaxLineCreateRequest country(CountryEnum country) { } /** - * Country + * Country of the area code * @return country */ @jakarta.annotation.Nonnull @@ -164,7 +164,7 @@ public FaxLineCreateRequest city(String city) { } /** - * City + * City of the area code * @return city */ @jakarta.annotation.Nullable @@ -189,7 +189,7 @@ public FaxLineCreateRequest accountId(String accountId) { } /** - * Account ID + * Account ID of the account that will be assigned this new Fax Line * @return accountId */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java index c7876dd3f..fb2e7beb5 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java @@ -65,7 +65,7 @@ public FaxLineDeleteRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * @return number */ @jakarta.annotation.Nonnull diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java index 747853a52..8467a4004 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java @@ -73,7 +73,7 @@ public FaxLineRemoveUserRequest number(String number) { } /** - * The Fax Line number. + * The Fax Line number * @return number */ @jakarta.annotation.Nonnull @@ -98,7 +98,7 @@ public FaxLineRemoveUserRequest accountId(String accountId) { } /** - * Account ID + * Account ID of the user to remove access * @return accountId */ @jakarta.annotation.Nullable @@ -123,7 +123,7 @@ public FaxLineRemoveUserRequest emailAddress(String emailAddress) { } /** - * Email address + * Email address of the user to remove access * @return emailAddress */ @jakarta.annotation.Nullable diff --git a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java index bb4a6e8a1..1830b7e87 100644 --- a/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java +++ b/sdks/java-v2/src/main/java/com/dropbox/sign/model/FaxSendRequest.java @@ -100,7 +100,7 @@ public FaxSendRequest recipient(String recipient) { } /** - * Fax Send To Recipient + * Recipient of the fax Can be a phone number in E.164 format or email address * @return recipient */ @jakarta.annotation.Nonnull @@ -158,7 +158,7 @@ public FaxSendRequest addFilesItem(File filesItem) { } /** - * Fax File to Send + * Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. * @return files */ @jakarta.annotation.Nullable @@ -191,7 +191,7 @@ public FaxSendRequest addFileUrlsItem(String fileUrlsItem) { } /** - * Fax File URL to Send + * Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. * @return fileUrls */ @jakarta.annotation.Nullable @@ -241,7 +241,7 @@ public FaxSendRequest coverPageTo(String coverPageTo) { } /** - * Fax Cover Page for Recipient + * Fax cover page recipient information * @return coverPageTo */ @jakarta.annotation.Nullable @@ -266,7 +266,7 @@ public FaxSendRequest coverPageFrom(String coverPageFrom) { } /** - * Fax Cover Page for Sender + * Fax cover page sender information * @return coverPageFrom */ @jakarta.annotation.Nullable diff --git a/sdks/node/api/faxApi.ts b/sdks/node/api/faxApi.ts index fdb7f9e9f..26e224280 100644 --- a/sdks/node/api/faxApi.ts +++ b/sdks/node/api/faxApi.ts @@ -119,7 +119,7 @@ export class FaxApi { } /** - * Deletes the specified Fax from the system. + * Deletes the specified Fax from the system * @summary Delete Fax * @param faxId Fax ID * @param options @@ -220,7 +220,7 @@ export class FaxApi { }); } /** - * Downloads fax files + * Downloads files associated with a Fax * @summary Download Fax Files * @param faxId Fax ID * @param options @@ -337,7 +337,7 @@ export class FaxApi { }); } /** - * Returns information about fax + * Returns information about a Fax * @summary Get Fax * @param faxId Fax ID * @param options @@ -454,10 +454,10 @@ export class FaxApi { }); } /** - * Returns properties of multiple faxes + * Returns properties of multiple Faxes * @summary Lists Faxes - * @param page Page - * @param pageSize Page size + * @param page Which page number of the Fax List to return. Defaults to `1`. + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. * @param options */ public async faxList( @@ -575,7 +575,7 @@ export class FaxApi { }); } /** - * Action to prepare and send a fax + * Creates and sends a new Fax with the submitted file(s) * @summary Send Fax * @param faxSendRequest * @param options diff --git a/sdks/node/api/faxLineApi.ts b/sdks/node/api/faxLineApi.ts index e9ca6c40d..24510ee88 100644 --- a/sdks/node/api/faxLineApi.ts +++ b/sdks/node/api/faxLineApi.ts @@ -261,12 +261,12 @@ export class FaxLineApi { }); } /** - * Returns a response with the area codes available for a given state/province and city. + * Returns a list of available area codes 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. - * @param province Filter area codes by province. - * @param city Filter area codes by city. + * @param country Filter area codes by country + * @param state Filter area codes by state + * @param province Filter area codes by province + * @param city Filter area codes by city * @param options */ public async faxLineAreaCodeGet( @@ -473,7 +473,7 @@ export class FaxLineApi { }); } /** - * Purchases a new Fax Line. + * Purchases a new Fax Line * @summary Purchase Fax Line * @param faxLineCreateRequest * @param options @@ -735,7 +735,7 @@ export class FaxLineApi { /** * Returns the properties and settings of a Fax Line. * @summary Get Fax Line - * @param number The Fax Line number. + * @param number The Fax Line number * @param options */ public async faxLineGet( @@ -855,9 +855,9 @@ export class FaxLineApi { * Returns the properties and settings of multiple Fax Lines. * @summary List Fax Lines * @param accountId Account ID - * @param page Page - * @param pageSize Page size - * @param showTeamLines Show team lines + * @param page Which page number of the Fax Line List to return. Defaults to `1`. + * @param pageSize Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. + * @param showTeamLines Include Fax Lines belonging to team members in the list * @param options */ public async faxLineList( @@ -993,7 +993,7 @@ export class FaxLineApi { }); } /** - * Removes a user\'s access to the specified Fax Line. + * Removes a user\'s access to the specified Fax Line * @summary Remove Fax Line Access * @param faxLineRemoveUserRequest * @param options diff --git a/sdks/node/docs/api/FaxApi.md b/sdks/node/docs/api/FaxApi.md index 775241da2..6a67c3316 100644 --- a/sdks/node/docs/api/FaxApi.md +++ b/sdks/node/docs/api/FaxApi.md @@ -19,7 +19,7 @@ faxDelete(faxId: string) Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### TypeScript Example @@ -90,7 +90,7 @@ faxFiles(faxId: string): Buffer Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### TypeScript Example @@ -169,7 +169,7 @@ faxGet(faxId: string): FaxGetResponse Get Fax -Returns information about fax +Returns information about a Fax ### TypeScript Example @@ -246,7 +246,7 @@ faxList(page: number, pageSize: number): FaxListResponse Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### TypeScript Example @@ -298,8 +298,8 @@ result.then(response => { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **page** | **number**| Page | [optional] [default to 1] | -| **pageSize** | **number**| Page size | [optional] [default to 20] | +| **page** | **number**| Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] | +| **pageSize** | **number**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -326,7 +326,7 @@ faxSend(faxSendRequest: FaxSendRequest): FaxGetResponse Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### TypeScript Example diff --git a/sdks/node/docs/api/FaxLineApi.md b/sdks/node/docs/api/FaxLineApi.md index ab90dd93e..dc59add61 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/province and city. +Returns a list of available area codes for a given state/province and city ### TypeScript Example @@ -150,10 +150,10 @@ result.then(response => { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **country** | **'CA' | 'US' | 'UK'**| Filter area codes by country. | | -| **state** | **'AK' | 'AL' | 'AR' | 'AZ' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'GA' | 'HI' | 'IA' | 'ID' | 'IL' | 'IN' | 'KS' | 'KY' | 'LA' | 'MA' | 'MD' | 'ME' | 'MI' | 'MN' | 'MO' | 'MS' | 'MT' | 'NC' | 'ND' | 'NE' | 'NH' | 'NJ' | 'NM' | 'NV' | 'NY' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VA' | 'VT' | 'WA' | 'WI' | 'WV' | 'WY'**| Filter area codes by state. | [optional] | -| **province** | **'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NT' | 'NS' | 'NU' | 'ON' | 'PE' | 'QC' | 'SK' | 'YT'**| Filter area codes by province. | [optional] | -| **city** | **string**| Filter area codes by city. | [optional] | +| **country** | **'CA' | 'US' | 'UK'**| Filter area codes by country | | +| **state** | **'AK' | 'AL' | 'AR' | 'AZ' | 'CA' | 'CO' | 'CT' | 'DC' | 'DE' | 'FL' | 'GA' | 'HI' | 'IA' | 'ID' | 'IL' | 'IN' | 'KS' | 'KY' | 'LA' | 'MA' | 'MD' | 'ME' | 'MI' | 'MN' | 'MO' | 'MS' | 'MT' | 'NC' | 'ND' | 'NE' | 'NH' | 'NJ' | 'NM' | 'NV' | 'NY' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VA' | 'VT' | 'WA' | 'WI' | 'WV' | 'WY'**| Filter area codes by state | [optional] | +| **province** | **'AB' | 'BC' | 'MB' | 'NB' | 'NL' | 'NT' | 'NS' | 'NU' | 'ON' | 'PE' | 'QC' | 'SK' | 'YT'**| Filter area codes by province | [optional] | +| **city** | **string**| Filter area codes by city | [optional] | ### Return type @@ -180,7 +180,7 @@ faxLineCreate(faxLineCreateRequest: FaxLineCreateRequest): FaxLineResponse Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### TypeScript Example @@ -388,7 +388,7 @@ result.then(response => { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **number** | **string**| The Fax Line number. | | +| **number** | **string**| The Fax Line number | | ### Return type @@ -462,9 +462,9 @@ result.then(response => { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **accountId** | **string**| Account ID | [optional] | -| **page** | **number**| Page | [optional] [default to 1] | -| **pageSize** | **number**| Page size | [optional] [default to 20] | -| **showTeamLines** | **boolean**| Show team lines | [optional] | +| **page** | **number**| Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] | +| **pageSize** | **number**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **showTeamLines** | **boolean**| Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -491,7 +491,7 @@ faxLineRemoveUser(faxLineRemoveUserRequest: FaxLineRemoveUserRequest): FaxLineRe Remove Fax Line Access -Removes a user\'s access to the specified Fax Line. +Removes a user\'s access to the specified Fax Line ### TypeScript Example diff --git a/sdks/node/docs/model/FaxLineAddUserRequest.md b/sdks/node/docs/model/FaxLineAddUserRequest.md index df23c2cdb..0b687c0d8 100644 --- a/sdks/node/docs/model/FaxLineAddUserRequest.md +++ b/sdks/node/docs/model/FaxLineAddUserRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | +| `number`*_required_ | ```string``` | The Fax Line number | | | `accountId` | ```string``` | Account ID | | | `emailAddress` | ```string``` | Email address | | diff --git a/sdks/node/docs/model/FaxLineCreateRequest.md b/sdks/node/docs/model/FaxLineCreateRequest.md index ae70b5cb9..6087b8973 100644 --- a/sdks/node/docs/model/FaxLineCreateRequest.md +++ b/sdks/node/docs/model/FaxLineCreateRequest.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `areaCode`*_required_ | ```number``` | Area code | | -| `country`*_required_ | ```string``` | Country | | -| `city` | ```string``` | City | | -| `accountId` | ```string``` | Account ID | | +| `areaCode`*_required_ | ```number``` | Area code of the new Fax Line | | +| `country`*_required_ | ```string``` | Country of the area code | | +| `city` | ```string``` | City of the area code | | +| `accountId` | ```string``` | Account ID of the account that will be assigned this new Fax Line | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/FaxLineDeleteRequest.md b/sdks/node/docs/model/FaxLineDeleteRequest.md index a2112ed33..fed4ee118 100644 --- a/sdks/node/docs/model/FaxLineDeleteRequest.md +++ b/sdks/node/docs/model/FaxLineDeleteRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | +| `number`*_required_ | ```string``` | The Fax Line number | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/FaxLineRemoveUserRequest.md b/sdks/node/docs/model/FaxLineRemoveUserRequest.md index e161ecf38..9ae81a65e 100644 --- a/sdks/node/docs/model/FaxLineRemoveUserRequest.md +++ b/sdks/node/docs/model/FaxLineRemoveUserRequest.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | -| `accountId` | ```string``` | Account ID | | -| `emailAddress` | ```string``` | Email address | | +| `number`*_required_ | ```string``` | The Fax Line number | | +| `accountId` | ```string``` | Account ID of the user to remove access | | +| `emailAddress` | ```string``` | Email address of the user to remove access | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/node/docs/model/FaxSendRequest.md b/sdks/node/docs/model/FaxSendRequest.md index 72ebb6fb0..9df85d9d2 100644 --- a/sdks/node/docs/model/FaxSendRequest.md +++ b/sdks/node/docs/model/FaxSendRequest.md @@ -6,13 +6,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `recipient`*_required_ | ```string``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```string``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```string``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```Array``` | Fax File to Send | | -| `fileUrls` | ```Array``` | Fax File URL to Send | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```Array``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `testMode` | ```boolean``` | API Test Mode Setting | [default to false] | -| `coverPageTo` | ```string``` | Fax Cover Page for Recipient | | -| `coverPageFrom` | ```string``` | Fax Cover Page for Sender | | +| `coverPageTo` | ```string``` | Fax cover page recipient information | | +| `coverPageFrom` | ```string``` | Fax cover page sender information | | | `coverPageMessage` | ```string``` | Fax Cover Page Message | | | `title` | ```string``` | Fax Title | | diff --git a/sdks/node/model/faxLineAddUserRequest.ts b/sdks/node/model/faxLineAddUserRequest.ts index 95b75de1b..5f890f7dd 100644 --- a/sdks/node/model/faxLineAddUserRequest.ts +++ b/sdks/node/model/faxLineAddUserRequest.ts @@ -26,7 +26,7 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class FaxLineAddUserRequest { /** - * The Fax Line number. + * The Fax Line number */ "number": string; /** diff --git a/sdks/node/model/faxLineCreateRequest.ts b/sdks/node/model/faxLineCreateRequest.ts index 3a67d60e4..764da8214 100644 --- a/sdks/node/model/faxLineCreateRequest.ts +++ b/sdks/node/model/faxLineCreateRequest.ts @@ -26,19 +26,19 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class FaxLineCreateRequest { /** - * Area code + * Area code of the new Fax Line */ "areaCode": number; /** - * Country + * Country of the area code */ "country": FaxLineCreateRequest.CountryEnum; /** - * City + * City of the area code */ "city"?: string; /** - * Account ID + * Account ID of the account that will be assigned this new Fax Line */ "accountId"?: string; diff --git a/sdks/node/model/faxLineDeleteRequest.ts b/sdks/node/model/faxLineDeleteRequest.ts index 26d8798c4..1cb2e63dc 100644 --- a/sdks/node/model/faxLineDeleteRequest.ts +++ b/sdks/node/model/faxLineDeleteRequest.ts @@ -26,7 +26,7 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class FaxLineDeleteRequest { /** - * The Fax Line number. + * The Fax Line number */ "number": string; diff --git a/sdks/node/model/faxLineRemoveUserRequest.ts b/sdks/node/model/faxLineRemoveUserRequest.ts index 02f921c6a..26e8b4e6b 100644 --- a/sdks/node/model/faxLineRemoveUserRequest.ts +++ b/sdks/node/model/faxLineRemoveUserRequest.ts @@ -26,15 +26,15 @@ import { AttributeTypeMap, ObjectSerializer } from "./"; export class FaxLineRemoveUserRequest { /** - * The Fax Line number. + * The Fax Line number */ "number": string; /** - * Account ID + * Account ID of the user to remove access */ "accountId"?: string; /** - * Email address + * Email address of the user to remove access */ "emailAddress"?: string; diff --git a/sdks/node/model/faxSendRequest.ts b/sdks/node/model/faxSendRequest.ts index 11ee71ef4..fcd45d645 100644 --- a/sdks/node/model/faxSendRequest.ts +++ b/sdks/node/model/faxSendRequest.ts @@ -26,7 +26,7 @@ import { AttributeTypeMap, ObjectSerializer, RequestFile } from "./"; export class FaxSendRequest { /** - * Fax Send To Recipient + * Recipient of the fax Can be a phone number in E.164 format or email address */ "recipient": string; /** @@ -34,11 +34,11 @@ export class FaxSendRequest { */ "sender"?: string; /** - * Fax File to Send + * Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. */ "files"?: Array; /** - * Fax File URL to Send + * Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. */ "fileUrls"?: Array; /** @@ -46,11 +46,11 @@ export class FaxSendRequest { */ "testMode"?: boolean = false; /** - * Fax Cover Page for Recipient + * Fax cover page recipient information */ "coverPageTo"?: string; /** - * Fax Cover Page for Sender + * Fax cover page sender information */ "coverPageFrom"?: string; /** diff --git a/sdks/php/docs/Api/FaxApi.md b/sdks/php/docs/Api/FaxApi.md index 78e411118..85450d672 100644 --- a/sdks/php/docs/Api/FaxApi.md +++ b/sdks/php/docs/Api/FaxApi.md @@ -18,7 +18,7 @@ faxDelete($fax_id) ``` Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example @@ -74,7 +74,7 @@ faxFiles($fax_id): \SplFileObject ``` Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Example @@ -133,7 +133,7 @@ faxGet($fax_id): \Dropbox\Sign\Model\FaxGetResponse ``` Get Fax -Returns information about fax +Returns information about a Fax ### Example @@ -192,7 +192,7 @@ faxList($page, $page_size): \Dropbox\Sign\Model\FaxListResponse ``` Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example @@ -226,8 +226,8 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **page** | **int**| Page | [optional] [default to 1] | -| **page_size** | **int**| Page size | [optional] [default to 20] | +| **page** | **int**| Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | ### Return type @@ -253,7 +253,7 @@ faxSend($fax_send_request): \Dropbox\Sign\Model\FaxGetResponse ``` Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example diff --git a/sdks/php/docs/Api/FaxLineApi.md b/sdks/php/docs/Api/FaxLineApi.md index 44789fc33..eb8df874f 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/province and city. +Returns a list of available area codes for a given state/province and city ### Example @@ -112,10 +112,10 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **country** | **string**| Filter area codes by country. | | -| **state** | **string**| Filter area codes by state. | [optional] | -| **province** | **string**| Filter area codes by province. | [optional] | -| **city** | **string**| Filter area codes by city. | [optional] | +| **country** | **string**| Filter area codes by country | | +| **state** | **string**| Filter area codes by state | [optional] | +| **province** | **string**| Filter area codes by province | [optional] | +| **city** | **string**| Filter area codes by city | [optional] | ### Return type @@ -141,7 +141,7 @@ faxLineCreate($fax_line_create_request): \Dropbox\Sign\Model\FaxLineResponse ``` Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example @@ -292,7 +292,7 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | -| **number** | **string**| The Fax Line number. | | +| **number** | **string**| The Fax Line number | | ### Return type @@ -350,9 +350,9 @@ try { |Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **account_id** | **string**| Account ID | [optional] | -| **page** | **int**| Page | [optional] [default to 1] | -| **page_size** | **int**| Page size | [optional] [default to 20] | -| **show_team_lines** | **bool**| Show team lines | [optional] | +| **page** | **int**| Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] | +| **page_size** | **int**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] | +| **show_team_lines** | **bool**| Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -378,7 +378,7 @@ faxLineRemoveUser($fax_line_remove_user_request): \Dropbox\Sign\Model\FaxLineRes ``` Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example diff --git a/sdks/php/docs/Model/FaxLineAddUserRequest.md b/sdks/php/docs/Model/FaxLineAddUserRequest.md index aef875b22..966ac619f 100644 --- a/sdks/php/docs/Model/FaxLineAddUserRequest.md +++ b/sdks/php/docs/Model/FaxLineAddUserRequest.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | +| `number`*_required_ | ```string``` | The Fax Line number | | | `account_id` | ```string``` | Account ID | | | `email_address` | ```string``` | Email address | | diff --git a/sdks/php/docs/Model/FaxLineCreateRequest.md b/sdks/php/docs/Model/FaxLineCreateRequest.md index 6b599a339..3483d66d8 100644 --- a/sdks/php/docs/Model/FaxLineCreateRequest.md +++ b/sdks/php/docs/Model/FaxLineCreateRequest.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `area_code`*_required_ | ```int``` | Area code | | -| `country`*_required_ | ```string``` | Country | | -| `city` | ```string``` | City | | -| `account_id` | ```string``` | Account ID | | +| `area_code`*_required_ | ```int``` | Area code of the new Fax Line | | +| `country`*_required_ | ```string``` | Country of the area code | | +| `city` | ```string``` | City of the area code | | +| `account_id` | ```string``` | Account ID of the account that will be assigned this new Fax Line | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineDeleteRequest.md b/sdks/php/docs/Model/FaxLineDeleteRequest.md index a2112ed33..fed4ee118 100644 --- a/sdks/php/docs/Model/FaxLineDeleteRequest.md +++ b/sdks/php/docs/Model/FaxLineDeleteRequest.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | +| `number`*_required_ | ```string``` | The Fax Line number | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxLineRemoveUserRequest.md b/sdks/php/docs/Model/FaxLineRemoveUserRequest.md index 6def01071..d5b79cefa 100644 --- a/sdks/php/docs/Model/FaxLineRemoveUserRequest.md +++ b/sdks/php/docs/Model/FaxLineRemoveUserRequest.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```string``` | The Fax Line number. | | -| `account_id` | ```string``` | Account ID | | -| `email_address` | ```string``` | Email address | | +| `number`*_required_ | ```string``` | The Fax Line number | | +| `account_id` | ```string``` | Account ID of the user to remove access | | +| `email_address` | ```string``` | Email address of the user to remove access | | [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) diff --git a/sdks/php/docs/Model/FaxSendRequest.md b/sdks/php/docs/Model/FaxSendRequest.md index dcbf730c4..432fd5ef6 100644 --- a/sdks/php/docs/Model/FaxSendRequest.md +++ b/sdks/php/docs/Model/FaxSendRequest.md @@ -6,13 +6,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `recipient`*_required_ | ```string``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```string``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```string``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```\SplFileObject[]``` | Fax File to Send | | -| `file_urls` | ```string[]``` | Fax File URL to Send | | +| `files` | ```\SplFileObject[]``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```string[]``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `test_mode` | ```bool``` | API Test Mode Setting | [default to false] | -| `cover_page_to` | ```string``` | Fax Cover Page for Recipient | | -| `cover_page_from` | ```string``` | Fax Cover Page for Sender | | +| `cover_page_to` | ```string``` | Fax cover page recipient information | | +| `cover_page_from` | ```string``` | Fax cover page sender information | | | `cover_page_message` | ```string``` | Fax Cover Page Message | | | `title` | ```string``` | Fax Title | | diff --git a/sdks/php/src/Api/FaxApi.php b/sdks/php/src/Api/FaxApi.php index 619778c5b..2669fedbc 100644 --- a/sdks/php/src/Api/FaxApi.php +++ b/sdks/php/src/Api/FaxApi.php @@ -1043,8 +1043,8 @@ public function faxGetRequest(string $fax_id, string $contentType = self::conten * * Lists Faxes * - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * * @return Model\FaxListResponse * @throws ApiException on non-2xx response or if the response body is not in the expected format @@ -1061,8 +1061,8 @@ public function faxList(int $page = 1, int $page_size = 20) * * Lists Faxes * - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * * @return array of Model\FaxListResponse, HTTP status code, HTTP response headers (array of strings) @@ -1199,8 +1199,8 @@ public function faxListWithHttpInfo(int $page = 1, int $page_size = 20, string $ * * Lists Faxes * - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -1222,8 +1222,8 @@ function ($response) { * * Lists Faxes * - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -1274,8 +1274,8 @@ function ($exception) { /** * Create request for operation 'faxList' * - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) + * @param int $page Which page number of the Fax List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxList'] to see the possible values for this operation * * @return Request diff --git a/sdks/php/src/Api/FaxLineApi.php b/sdks/php/src/Api/FaxLineApi.php index 65cefff54..baeb810b1 100644 --- a/sdks/php/src/Api/FaxLineApi.php +++ b/sdks/php/src/Api/FaxLineApi.php @@ -486,10 +486,10 @@ public function faxLineAddUserRequest(Model\FaxLineAddUserRequest $fax_line_add_ * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country. (required) - * @param string $state Filter area codes by state. (optional) - * @param string $province Filter area codes by province. (optional) - * @param string $city Filter area codes by city. (optional) + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) * * @return Model\FaxLineAreaCodeGetResponse * @throws ApiException on non-2xx response or if the response body is not in the expected format @@ -506,10 +506,10 @@ public function faxLineAreaCodeGet(string $country, string $state = null, string * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country. (required) - * @param string $state Filter area codes by state. (optional) - * @param string $province Filter area codes by province. (optional) - * @param string $city Filter area codes by city. (optional) + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * * @return array of Model\FaxLineAreaCodeGetResponse, HTTP status code, HTTP response headers (array of strings) @@ -646,10 +646,10 @@ public function faxLineAreaCodeGetWithHttpInfo(string $country, string $state = * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country. (required) - * @param string $state Filter area codes by state. (optional) - * @param string $province Filter area codes by province. (optional) - * @param string $city Filter area codes by city. (optional) + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -671,10 +671,10 @@ function ($response) { * * Get Available Fax Line Area Codes * - * @param string $country Filter area codes by country. (required) - * @param string $state Filter area codes by state. (optional) - * @param string $province Filter area codes by province. (optional) - * @param string $city Filter area codes by city. (optional) + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -725,10 +725,10 @@ function ($exception) { /** * Create request for operation 'faxLineAreaCodeGet' * - * @param string $country Filter area codes by country. (required) - * @param string $state Filter area codes by state. (optional) - * @param string $province Filter area codes by province. (optional) - * @param string $city Filter area codes by city. (optional) + * @param string $country Filter area codes by country (required) + * @param string $state Filter area codes by state (optional) + * @param string $province Filter area codes by province (optional) + * @param string $city Filter area codes by city (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineAreaCodeGet'] to see the possible values for this operation * * @return Request @@ -1439,7 +1439,7 @@ public function faxLineDeleteRequest(Model\FaxLineDeleteRequest $fax_line_delete * * Get Fax Line * - * @param string $number The Fax Line number. (required) + * @param string $number The Fax Line number (required) * * @return Model\FaxLineResponse * @throws ApiException on non-2xx response or if the response body is not in the expected format @@ -1456,7 +1456,7 @@ public function faxLineGet(string $number) * * Get Fax Line * - * @param string $number The Fax Line number. (required) + * @param string $number The Fax Line number (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * * @return array of Model\FaxLineResponse, HTTP status code, HTTP response headers (array of strings) @@ -1593,7 +1593,7 @@ public function faxLineGetWithHttpInfo(string $number, string $contentType = sel * * Get Fax Line * - * @param string $number The Fax Line number. (required) + * @param string $number The Fax Line number (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -1615,7 +1615,7 @@ function ($response) { * * Get Fax Line * - * @param string $number The Fax Line number. (required) + * @param string $number The Fax Line number (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -1666,7 +1666,7 @@ function ($exception) { /** * Create request for operation 'faxLineGet' * - * @param string $number The Fax Line number. (required) + * @param string $number The Fax Line number (required) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineGet'] to see the possible values for this operation * * @return Request @@ -1769,9 +1769,9 @@ public function faxLineGetRequest(string $number, string $contentType = self::co * List Fax Lines * * @param string $account_id Account ID (optional) - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param bool $show_team_lines Show team lines (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) * * @return Model\FaxLineListResponse * @throws ApiException on non-2xx response or if the response body is not in the expected format @@ -1789,9 +1789,9 @@ public function faxLineList(string $account_id = null, int $page = 1, int $page_ * List Fax Lines * * @param string $account_id Account ID (optional) - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param bool $show_team_lines Show team lines (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * * @return array of Model\FaxLineListResponse, HTTP status code, HTTP response headers (array of strings) @@ -1929,9 +1929,9 @@ public function faxLineListWithHttpInfo(string $account_id = null, int $page = 1 * List Fax Lines * * @param string $account_id Account ID (optional) - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param bool $show_team_lines Show team lines (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -1954,9 +1954,9 @@ function ($response) { * List Fax Lines * * @param string $account_id Account ID (optional) - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param bool $show_team_lines Show team lines (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * * @return \GuzzleHttp\Promise\PromiseInterface @@ -2008,9 +2008,9 @@ function ($exception) { * Create request for operation 'faxLineList' * * @param string $account_id Account ID (optional) - * @param int $page Page (optional, default to 1) - * @param int $page_size Page size (optional, default to 20) - * @param bool $show_team_lines Show team lines (optional) + * @param int $page Which page number of the Fax Line List to return. Defaults to `1`. (optional, default to 1) + * @param int $page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20) + * @param bool $show_team_lines Include Fax Lines belonging to team members in the list (optional) * @param string $contentType The value for the Content-Type header. Check self::contentTypes['faxLineList'] to see the possible values for this operation * * @return Request diff --git a/sdks/php/src/Model/FaxLineAddUserRequest.php b/sdks/php/src/Model/FaxLineAddUserRequest.php index b7e2c849a..837f4885d 100644 --- a/sdks/php/src/Model/FaxLineAddUserRequest.php +++ b/sdks/php/src/Model/FaxLineAddUserRequest.php @@ -327,7 +327,7 @@ public function getNumber() /** * Sets number * - * @param string $number the Fax Line number + * @param string $number The Fax Line number * * @return self */ diff --git a/sdks/php/src/Model/FaxLineCreateRequest.php b/sdks/php/src/Model/FaxLineCreateRequest.php index a898fef9d..5412325a0 100644 --- a/sdks/php/src/Model/FaxLineCreateRequest.php +++ b/sdks/php/src/Model/FaxLineCreateRequest.php @@ -364,7 +364,7 @@ public function getAreaCode() /** * Sets area_code * - * @param int $area_code Area code + * @param int $area_code Area code of the new Fax Line * * @return self */ @@ -391,7 +391,7 @@ public function getCountry() /** * Sets country * - * @param string $country Country + * @param string $country Country of the area code * * @return self */ @@ -428,7 +428,7 @@ public function getCity() /** * Sets city * - * @param string|null $city City + * @param string|null $city City of the area code * * @return self */ @@ -455,7 +455,7 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id Account ID + * @param string|null $account_id Account ID of the account that will be assigned this new Fax Line * * @return self */ diff --git a/sdks/php/src/Model/FaxLineDeleteRequest.php b/sdks/php/src/Model/FaxLineDeleteRequest.php index 1fc4fa4a6..9426ce2af 100644 --- a/sdks/php/src/Model/FaxLineDeleteRequest.php +++ b/sdks/php/src/Model/FaxLineDeleteRequest.php @@ -313,7 +313,7 @@ public function getNumber() /** * Sets number * - * @param string $number the Fax Line number + * @param string $number The Fax Line number * * @return self */ diff --git a/sdks/php/src/Model/FaxLineRemoveUserRequest.php b/sdks/php/src/Model/FaxLineRemoveUserRequest.php index 5bec49060..560b147e7 100644 --- a/sdks/php/src/Model/FaxLineRemoveUserRequest.php +++ b/sdks/php/src/Model/FaxLineRemoveUserRequest.php @@ -327,7 +327,7 @@ public function getNumber() /** * Sets number * - * @param string $number the Fax Line number + * @param string $number The Fax Line number * * @return self */ @@ -354,7 +354,7 @@ public function getAccountId() /** * Sets account_id * - * @param string|null $account_id Account ID + * @param string|null $account_id Account ID of the user to remove access * * @return self */ @@ -381,7 +381,7 @@ public function getEmailAddress() /** * Sets email_address * - * @param string|null $email_address Email address + * @param string|null $email_address Email address of the user to remove access * * @return self */ diff --git a/sdks/php/src/Model/FaxSendRequest.php b/sdks/php/src/Model/FaxSendRequest.php index d09573478..6124050b3 100644 --- a/sdks/php/src/Model/FaxSendRequest.php +++ b/sdks/php/src/Model/FaxSendRequest.php @@ -370,7 +370,7 @@ public function getRecipient() /** * Sets recipient * - * @param string $recipient Fax Send To Recipient + * @param string $recipient Recipient of the fax Can be a phone number in E.164 format or email address * * @return self */ @@ -424,7 +424,7 @@ public function getFiles() /** * Sets files * - * @param SplFileObject[]|null $files Fax File to Send + * @param SplFileObject[]|null $files use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both * * @return self */ @@ -451,7 +451,7 @@ public function getFileUrls() /** * Sets file_urls * - * @param string[]|null $file_urls Fax File URL to Send + * @param string[]|null $file_urls use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both * * @return self */ @@ -505,7 +505,7 @@ public function getCoverPageTo() /** * Sets cover_page_to * - * @param string|null $cover_page_to Fax Cover Page for Recipient + * @param string|null $cover_page_to Fax cover page recipient information * * @return self */ @@ -532,7 +532,7 @@ public function getCoverPageFrom() /** * Sets cover_page_from * - * @param string|null $cover_page_from Fax Cover Page for Sender + * @param string|null $cover_page_from Fax cover page sender information * * @return self */ diff --git a/sdks/python/docs/FaxApi.md b/sdks/python/docs/FaxApi.md index 93ec15305..44b5a5c87 100644 --- a/sdks/python/docs/FaxApi.md +++ b/sdks/python/docs/FaxApi.md @@ -16,7 +16,7 @@ Method | HTTP request | Description Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Example @@ -75,7 +75,7 @@ void (empty response body) Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Example @@ -137,7 +137,7 @@ with ApiClient(configuration) as api_client: Get Fax -Returns information about fax +Returns information about a Fax ### Example @@ -199,7 +199,7 @@ with ApiClient(configuration) as api_client: Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Example @@ -236,8 +236,8 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `page` | **int** | Page | [optional][default to 1] | -| `page_size` | **int** | Page size | [optional][default to 20] | +| `page` | **int** | Which page number of the Fax List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **int** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | ### Return type @@ -266,7 +266,7 @@ with ApiClient(configuration) as api_client: Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Example diff --git a/sdks/python/docs/FaxLineAddUserRequest.md b/sdks/python/docs/FaxLineAddUserRequest.md index 9d2c5e199..ddc1053ff 100644 --- a/sdks/python/docs/FaxLineAddUserRequest.md +++ b/sdks/python/docs/FaxLineAddUserRequest.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```str``` | The Fax Line number. | | +| `number`*_required_ | ```str``` | The Fax Line number | | | `account_id` | ```str``` | Account ID | | | `email_address` | ```str``` | Email address | | diff --git a/sdks/python/docs/FaxLineApi.md b/sdks/python/docs/FaxLineApi.md index 0846b3384..288342e81 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/province and city. +Returns a list of available area codes for a given state/province and city ### Example @@ -114,10 +114,10 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `country` | **str** | Filter area codes by country. | | -| `state` | **str** | Filter area codes by state. | [optional] | -| `province` | **str** | Filter area codes by province. | [optional] | -| `city` | **str** | Filter area codes by city. | [optional] | +| `country` | **str** | Filter area codes by country | | +| `state` | **str** | Filter area codes by state | [optional] | +| `province` | **str** | Filter area codes by province | [optional] | +| `city` | **str** | Filter area codes by city | [optional] | ### Return type @@ -146,7 +146,7 @@ with ApiClient(configuration) as api_client: Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Example @@ -305,7 +305,7 @@ with ApiClient(configuration) as api_client: ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number` | **str** | The Fax Line number. | | +| `number` | **str** | The Fax Line number | | ### Return type @@ -366,9 +366,9 @@ with ApiClient(configuration) as api_client: | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account_id` | **str** | Account ID | [optional] | -| `page` | **int** | Page | [optional][default to 1] | -| `page_size` | **int** | Page size | [optional][default to 20] | -| `show_team_lines` | **bool** | Show team lines | [optional] | +| `page` | **int** | Which page number of the Fax Line List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **int** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | +| `show_team_lines` | **bool** | Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -397,7 +397,7 @@ with ApiClient(configuration) as api_client: Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Example diff --git a/sdks/python/docs/FaxLineCreateRequest.md b/sdks/python/docs/FaxLineCreateRequest.md index b6b33b3ac..0f53c117c 100644 --- a/sdks/python/docs/FaxLineCreateRequest.md +++ b/sdks/python/docs/FaxLineCreateRequest.md @@ -5,10 +5,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `area_code`*_required_ | ```int``` | Area code | | -| `country`*_required_ | ```str``` | Country | | -| `city` | ```str``` | City | | -| `account_id` | ```str``` | Account ID | | +| `area_code`*_required_ | ```int``` | Area code of the new Fax Line | | +| `country`*_required_ | ```str``` | Country of the area code | | +| `city` | ```str``` | City of the area code | | +| `account_id` | ```str``` | Account ID of the account that will be assigned this new Fax Line | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/FaxLineDeleteRequest.md b/sdks/python/docs/FaxLineDeleteRequest.md index ad6985a8e..ad8c4dfe6 100644 --- a/sdks/python/docs/FaxLineDeleteRequest.md +++ b/sdks/python/docs/FaxLineDeleteRequest.md @@ -5,7 +5,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```str``` | The Fax Line number. | | +| `number`*_required_ | ```str``` | The Fax Line number | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/FaxLineRemoveUserRequest.md b/sdks/python/docs/FaxLineRemoveUserRequest.md index 561ddea6d..e2813a0ed 100644 --- a/sdks/python/docs/FaxLineRemoveUserRequest.md +++ b/sdks/python/docs/FaxLineRemoveUserRequest.md @@ -5,9 +5,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `number`*_required_ | ```str``` | The Fax Line number. | | -| `account_id` | ```str``` | Account ID | | -| `email_address` | ```str``` | Email address | | +| `number`*_required_ | ```str``` | The Fax Line number | | +| `account_id` | ```str``` | Account ID of the user to remove access | | +| `email_address` | ```str``` | Email address of the user to remove access | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/sdks/python/docs/FaxSendRequest.md b/sdks/python/docs/FaxSendRequest.md index cdb4f49a0..50bed5b61 100644 --- a/sdks/python/docs/FaxSendRequest.md +++ b/sdks/python/docs/FaxSendRequest.md @@ -5,13 +5,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -| `recipient`*_required_ | ```str``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```str``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```str``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```List[io.IOBase]``` | Fax File to Send | | -| `file_urls` | ```List[str]``` | Fax File URL to Send | | +| `files` | ```List[io.IOBase]``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```List[str]``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `test_mode` | ```bool``` | API Test Mode Setting | [default to False] | -| `cover_page_to` | ```str``` | Fax Cover Page for Recipient | | -| `cover_page_from` | ```str``` | Fax Cover Page for Sender | | +| `cover_page_to` | ```str``` | Fax cover page recipient information | | +| `cover_page_from` | ```str``` | Fax cover page sender information | | | `cover_page_message` | ```str``` | Fax Cover Page Message | | | `title` | ```str``` | Fax Title | | diff --git a/sdks/python/dropbox_sign/api/fax_api.py b/sdks/python/dropbox_sign/api/fax_api.py index 7d286fc97..4cf485a75 100644 --- a/sdks/python/dropbox_sign/api/fax_api.py +++ b/sdks/python/dropbox_sign/api/fax_api.py @@ -60,7 +60,7 @@ def fax_delete( ) -> None: """Delete Fax - Deletes the specified Fax from the system. + Deletes the specified Fax from the system :param fax_id: Fax ID (required) :type fax_id: str @@ -125,7 +125,7 @@ def fax_delete_with_http_info( ) -> ApiResponse[None]: """Delete Fax - Deletes the specified Fax from the system. + Deletes the specified Fax from the system :param fax_id: Fax ID (required) :type fax_id: str @@ -190,7 +190,7 @@ def fax_delete_without_preload_content( ) -> RESTResponseType: """Delete Fax - Deletes the specified Fax from the system. + Deletes the specified Fax from the system :param fax_id: Fax ID (required) :type fax_id: str @@ -303,7 +303,7 @@ def fax_files( ) -> io.IOBase: """Download Fax Files - Downloads fax files + Downloads files associated with a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -368,7 +368,7 @@ def fax_files_with_http_info( ) -> ApiResponse[io.IOBase]: """Download Fax Files - Downloads fax files + Downloads files associated with a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -433,7 +433,7 @@ def fax_files_without_preload_content( ) -> RESTResponseType: """Download Fax Files - Downloads fax files + Downloads files associated with a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -546,7 +546,7 @@ def fax_get( ) -> FaxGetResponse: """Get Fax - Returns information about fax + Returns information about a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -611,7 +611,7 @@ def fax_get_with_http_info( ) -> ApiResponse[FaxGetResponse]: """Get Fax - Returns information about fax + Returns information about a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -676,7 +676,7 @@ def fax_get_without_preload_content( ) -> RESTResponseType: """Get Fax - Returns information about fax + Returns information about a Fax :param fax_id: Fax ID (required) :type fax_id: str @@ -776,11 +776,15 @@ def fax_list( self, page: Annotated[ Optional[Annotated[int, Field(strict=True, ge=1)]], - Field(description="Page"), + Field( + description="Which page number of the Fax List to return. Defaults to `1`." + ), ] = None, page_size: Annotated[ Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], - Field(description="Page size"), + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, _request_timeout: Union[ None, @@ -796,11 +800,11 @@ def fax_list( ) -> FaxListResponse: """Lists Faxes - Returns properties of multiple faxes + Returns properties of multiple Faxes - :param page: Page + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -851,11 +855,15 @@ def fax_list_with_http_info( self, page: Annotated[ Optional[Annotated[int, Field(strict=True, ge=1)]], - Field(description="Page"), + Field( + description="Which page number of the Fax List to return. Defaults to `1`." + ), ] = None, page_size: Annotated[ Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], - Field(description="Page size"), + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, _request_timeout: Union[ None, @@ -871,11 +879,11 @@ def fax_list_with_http_info( ) -> ApiResponse[FaxListResponse]: """Lists Faxes - Returns properties of multiple faxes + Returns properties of multiple Faxes - :param page: Page + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -926,11 +934,15 @@ def fax_list_without_preload_content( self, page: Annotated[ Optional[Annotated[int, Field(strict=True, ge=1)]], - Field(description="Page"), + Field( + description="Which page number of the Fax List to return. Defaults to `1`." + ), ] = None, page_size: Annotated[ Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], - Field(description="Page size"), + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, _request_timeout: Union[ None, @@ -946,11 +958,11 @@ def fax_list_without_preload_content( ) -> RESTResponseType: """Lists Faxes - Returns properties of multiple faxes + Returns properties of multiple Faxes - :param page: Page + :param page: Which page number of the Fax List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1069,7 +1081,7 @@ def fax_send( ) -> FaxGetResponse: """Send Fax - Action to prepare and send a fax + Creates and sends a new Fax with the submitted file(s) :param fax_send_request: (required) :type fax_send_request: FaxSendRequest @@ -1134,7 +1146,7 @@ def fax_send_with_http_info( ) -> ApiResponse[FaxGetResponse]: """Send Fax - Action to prepare and send a fax + Creates and sends a new Fax with the submitted file(s) :param fax_send_request: (required) :type fax_send_request: FaxSendRequest @@ -1199,7 +1211,7 @@ def fax_send_without_preload_content( ) -> RESTResponseType: """Send Fax - Action to prepare and send a fax + Creates and sends a new Fax with the submitted file(s) :param fax_send_request: (required) :type fax_send_request: FaxSendRequest diff --git a/sdks/python/dropbox_sign/api/fax_line_api.py b/sdks/python/dropbox_sign/api/fax_line_api.py index 50b55d795..b2949be41 100644 --- a/sdks/python/dropbox_sign/api/fax_line_api.py +++ b/sdks/python/dropbox_sign/api/fax_line_api.py @@ -327,16 +327,16 @@ def _fax_line_add_user_serialize( def fax_line_area_code_get( self, country: Annotated[ - StrictStr, Field(description="Filter area codes by country.") + StrictStr, Field(description="Filter area codes by country") ], state: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by state.") + Optional[StrictStr], Field(description="Filter area codes by state") ] = None, province: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by province.") + Optional[StrictStr], Field(description="Filter area codes by province") ] = None, city: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by city.") + Optional[StrictStr], Field(description="Filter area codes by city") ] = None, _request_timeout: Union[ None, @@ -352,15 +352,15 @@ 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/province and city. + Returns a list of available area codes for a given state/province and city - :param country: Filter area codes by country. (required) + :param country: Filter area codes by country (required) :type country: str - :param state: Filter area codes by state. + :param state: Filter area codes by state :type state: str - :param province: Filter area codes by province. + :param province: Filter area codes by province :type province: str - :param city: Filter area codes by city. + :param city: Filter area codes by city :type city: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -412,16 +412,16 @@ def fax_line_area_code_get( def fax_line_area_code_get_with_http_info( self, country: Annotated[ - StrictStr, Field(description="Filter area codes by country.") + StrictStr, Field(description="Filter area codes by country") ], state: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by state.") + Optional[StrictStr], Field(description="Filter area codes by state") ] = None, province: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by province.") + Optional[StrictStr], Field(description="Filter area codes by province") ] = None, city: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by city.") + Optional[StrictStr], Field(description="Filter area codes by city") ] = None, _request_timeout: Union[ None, @@ -437,15 +437,15 @@ 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/province and city. + Returns a list of available area codes for a given state/province and city - :param country: Filter area codes by country. (required) + :param country: Filter area codes by country (required) :type country: str - :param state: Filter area codes by state. + :param state: Filter area codes by state :type state: str - :param province: Filter area codes by province. + :param province: Filter area codes by province :type province: str - :param city: Filter area codes by city. + :param city: Filter area codes by city :type city: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -497,16 +497,16 @@ def fax_line_area_code_get_with_http_info( def fax_line_area_code_get_without_preload_content( self, country: Annotated[ - StrictStr, Field(description="Filter area codes by country.") + StrictStr, Field(description="Filter area codes by country") ], state: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by state.") + Optional[StrictStr], Field(description="Filter area codes by state") ] = None, province: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by province.") + Optional[StrictStr], Field(description="Filter area codes by province") ] = None, city: Annotated[ - Optional[StrictStr], Field(description="Filter area codes by city.") + Optional[StrictStr], Field(description="Filter area codes by city") ] = None, _request_timeout: Union[ None, @@ -522,15 +522,15 @@ 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/province and city. + Returns a list of available area codes for a given state/province and city - :param country: Filter area codes by country. (required) + :param country: Filter area codes by country (required) :type country: str - :param state: Filter area codes by state. + :param state: Filter area codes by state :type state: str - :param province: Filter area codes by province. + :param province: Filter area codes by province :type province: str - :param city: Filter area codes by city. + :param city: Filter area codes by city :type city: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -661,7 +661,7 @@ def fax_line_create( ) -> FaxLineResponse: """Purchase Fax Line - Purchases a new Fax Line. + Purchases a new Fax Line :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest @@ -726,7 +726,7 @@ def fax_line_create_with_http_info( ) -> ApiResponse[FaxLineResponse]: """Purchase Fax Line - Purchases a new Fax Line. + Purchases a new Fax Line :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest @@ -791,7 +791,7 @@ def fax_line_create_without_preload_content( ) -> RESTResponseType: """Purchase Fax Line - Purchases a new Fax Line. + Purchases a new Fax Line :param fax_line_create_request: (required) :type fax_line_create_request: FaxLineCreateRequest @@ -1196,7 +1196,7 @@ def _fax_line_delete_serialize( @validate_call def fax_line_get( self, - number: Annotated[StrictStr, Field(description="The Fax Line number.")], + number: Annotated[StrictStr, Field(description="The Fax Line number")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1213,7 +1213,7 @@ def fax_line_get( Returns the properties and settings of a Fax Line. - :param number: The Fax Line number. (required) + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1261,7 +1261,7 @@ def fax_line_get( @validate_call def fax_line_get_with_http_info( self, - number: Annotated[StrictStr, Field(description="The Fax Line number.")], + number: Annotated[StrictStr, Field(description="The Fax Line number")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1278,7 +1278,7 @@ def fax_line_get_with_http_info( Returns the properties and settings of a Fax Line. - :param number: The Fax Line number. (required) + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1326,7 +1326,7 @@ def fax_line_get_with_http_info( @validate_call def fax_line_get_without_preload_content( self, - number: Annotated[StrictStr, Field(description="The Fax Line number.")], + number: Annotated[StrictStr, Field(description="The Fax Line number")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1343,7 +1343,7 @@ def fax_line_get_without_preload_content( Returns the properties and settings of a Fax Line. - :param number: The Fax Line number. (required) + :param number: The Fax Line number (required) :type number: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1444,12 +1444,23 @@ def fax_line_list( account_id: Annotated[ Optional[StrictStr], Field(description="Account ID") ] = None, - page: Annotated[Optional[StrictInt], Field(description="Page")] = None, + page: Annotated[ + Optional[StrictInt], + Field( + description="Which page number of the Fax Line List to return. Defaults to `1`." + ), + ] = None, page_size: Annotated[ - Optional[StrictInt], Field(description="Page size") + Optional[StrictInt], + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, show_team_lines: Annotated[ - Optional[StrictBool], Field(description="Show team lines") + Optional[StrictBool], + Field( + description="Include Fax Lines belonging to team members in the list" + ), ] = None, _request_timeout: Union[ None, @@ -1469,11 +1480,11 @@ def fax_line_list( :param account_id: Account ID :type account_id: str - :param page: Page + :param page: Which page number of the Fax Line List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int - :param show_team_lines: Show team lines + :param show_team_lines: Include Fax Lines belonging to team members in the list :type show_team_lines: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1527,12 +1538,23 @@ def fax_line_list_with_http_info( account_id: Annotated[ Optional[StrictStr], Field(description="Account ID") ] = None, - page: Annotated[Optional[StrictInt], Field(description="Page")] = None, + page: Annotated[ + Optional[StrictInt], + Field( + description="Which page number of the Fax Line List to return. Defaults to `1`." + ), + ] = None, page_size: Annotated[ - Optional[StrictInt], Field(description="Page size") + Optional[StrictInt], + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, show_team_lines: Annotated[ - Optional[StrictBool], Field(description="Show team lines") + Optional[StrictBool], + Field( + description="Include Fax Lines belonging to team members in the list" + ), ] = None, _request_timeout: Union[ None, @@ -1552,11 +1574,11 @@ def fax_line_list_with_http_info( :param account_id: Account ID :type account_id: str - :param page: Page + :param page: Which page number of the Fax Line List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int - :param show_team_lines: Show team lines + :param show_team_lines: Include Fax Lines belonging to team members in the list :type show_team_lines: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1610,12 +1632,23 @@ def fax_line_list_without_preload_content( account_id: Annotated[ Optional[StrictStr], Field(description="Account ID") ] = None, - page: Annotated[Optional[StrictInt], Field(description="Page")] = None, + page: Annotated[ + Optional[StrictInt], + Field( + description="Which page number of the Fax Line List to return. Defaults to `1`." + ), + ] = None, page_size: Annotated[ - Optional[StrictInt], Field(description="Page size") + Optional[StrictInt], + Field( + description="Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`." + ), ] = None, show_team_lines: Annotated[ - Optional[StrictBool], Field(description="Show team lines") + Optional[StrictBool], + Field( + description="Include Fax Lines belonging to team members in the list" + ), ] = None, _request_timeout: Union[ None, @@ -1635,11 +1668,11 @@ def fax_line_list_without_preload_content( :param account_id: Account ID :type account_id: str - :param page: Page + :param page: Which page number of the Fax Line List to return. Defaults to `1`. :type page: int - :param page_size: Page size + :param page_size: Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. :type page_size: int - :param show_team_lines: Show team lines + :param show_team_lines: Include Fax Lines belonging to team members in the list :type show_team_lines: bool :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1770,7 +1803,7 @@ def fax_line_remove_user( ) -> FaxLineResponse: """Remove Fax Line Access - Removes a user's access to the specified Fax Line. + Removes a user's access to the specified Fax Line :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest @@ -1835,7 +1868,7 @@ def fax_line_remove_user_with_http_info( ) -> ApiResponse[FaxLineResponse]: """Remove Fax Line Access - Removes a user's access to the specified Fax Line. + Removes a user's access to the specified Fax Line :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest @@ -1900,7 +1933,7 @@ def fax_line_remove_user_without_preload_content( ) -> RESTResponseType: """Remove Fax Line Access - Removes a user's access to the specified Fax Line. + Removes a user's access to the specified Fax Line :param fax_line_remove_user_request: (required) :type fax_line_remove_user_request: FaxLineRemoveUserRequest diff --git a/sdks/python/dropbox_sign/models/fax_line_add_user_request.py b/sdks/python/dropbox_sign/models/fax_line_add_user_request.py index e4f92da3a..59ba5dbe9 100644 --- a/sdks/python/dropbox_sign/models/fax_line_add_user_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_add_user_request.py @@ -32,7 +32,7 @@ class FaxLineAddUserRequest(BaseModel): FaxLineAddUserRequest """ # noqa: E501 - number: StrictStr = Field(description="The Fax Line number.") + number: StrictStr = Field(description="The Fax Line number") account_id: Optional[StrictStr] = Field(default=None, description="Account ID") email_address: Optional[StrictStr] = Field( default=None, description="Email address" diff --git a/sdks/python/dropbox_sign/models/fax_line_create_request.py b/sdks/python/dropbox_sign/models/fax_line_create_request.py index 459e36ee6..3548180dc 100644 --- a/sdks/python/dropbox_sign/models/fax_line_create_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_create_request.py @@ -32,10 +32,13 @@ class FaxLineCreateRequest(BaseModel): FaxLineCreateRequest """ # noqa: E501 - area_code: StrictInt = Field(description="Area code") - country: StrictStr = Field(description="Country") - city: Optional[StrictStr] = Field(default=None, description="City") - account_id: Optional[StrictStr] = Field(default=None, description="Account ID") + area_code: StrictInt = Field(description="Area code of the new Fax Line") + country: StrictStr = Field(description="Country of the area code") + city: Optional[StrictStr] = Field(default=None, description="City of the area code") + account_id: Optional[StrictStr] = Field( + default=None, + description="Account ID of the account that will be assigned this new Fax Line", + ) __properties: ClassVar[List[str]] = ["area_code", "country", "city", "account_id"] @field_validator("country") diff --git a/sdks/python/dropbox_sign/models/fax_line_delete_request.py b/sdks/python/dropbox_sign/models/fax_line_delete_request.py index 140112ffa..b65b06f17 100644 --- a/sdks/python/dropbox_sign/models/fax_line_delete_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_delete_request.py @@ -32,7 +32,7 @@ class FaxLineDeleteRequest(BaseModel): FaxLineDeleteRequest """ # noqa: E501 - number: StrictStr = Field(description="The Fax Line number.") + number: StrictStr = Field(description="The Fax Line number") __properties: ClassVar[List[str]] = ["number"] model_config = ConfigDict( diff --git a/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py b/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py index 710dc10cb..371178063 100644 --- a/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py +++ b/sdks/python/dropbox_sign/models/fax_line_remove_user_request.py @@ -32,10 +32,12 @@ class FaxLineRemoveUserRequest(BaseModel): FaxLineRemoveUserRequest """ # noqa: E501 - number: StrictStr = Field(description="The Fax Line number.") - account_id: Optional[StrictStr] = Field(default=None, description="Account ID") + number: StrictStr = Field(description="The Fax Line number") + account_id: Optional[StrictStr] = Field( + default=None, description="Account ID of the user to remove access" + ) email_address: Optional[StrictStr] = Field( - default=None, description="Email address" + default=None, description="Email address of the user to remove access" ) __properties: ClassVar[List[str]] = ["number", "account_id", "email_address"] diff --git a/sdks/python/dropbox_sign/models/fax_send_request.py b/sdks/python/dropbox_sign/models/fax_send_request.py index a26c775de..4b6428230 100644 --- a/sdks/python/dropbox_sign/models/fax_send_request.py +++ b/sdks/python/dropbox_sign/models/fax_send_request.py @@ -32,24 +32,28 @@ class FaxSendRequest(BaseModel): FaxSendRequest """ # noqa: E501 - recipient: StrictStr = Field(description="Fax Send To Recipient") + recipient: StrictStr = Field( + description="Recipient of the fax Can be a phone number in E.164 format or email address" + ) sender: Optional[StrictStr] = Field( default=None, description="Fax Send From Sender (used only with fax number)" ) files: Optional[List[Union[StrictBytes, StrictStr, io.IOBase]]] = Field( - default=None, description="Fax File to Send" + default=None, + description="Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both.", ) file_urls: Optional[List[StrictStr]] = Field( - default=None, description="Fax File URL to Send" + default=None, + description="Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both.", ) test_mode: Optional[StrictBool] = Field( default=False, description="API Test Mode Setting" ) cover_page_to: Optional[StrictStr] = Field( - default=None, description="Fax Cover Page for Recipient" + default=None, description="Fax cover page recipient information" ) cover_page_from: Optional[StrictStr] = Field( - default=None, description="Fax Cover Page for Sender" + default=None, description="Fax cover page sender information" ) cover_page_message: Optional[StrictStr] = Field( default=None, description="Fax Cover Page Message" diff --git a/sdks/ruby/docs/FaxApi.md b/sdks/ruby/docs/FaxApi.md index a0e05a605..a260d58dc 100644 --- a/sdks/ruby/docs/FaxApi.md +++ b/sdks/ruby/docs/FaxApi.md @@ -17,7 +17,7 @@ All URIs are relative to *https://api.hellosign.com/v3* Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### Examples @@ -83,7 +83,7 @@ nil (empty response body) Download Fax Files -Downloads fax files +Downloads files associated with a Fax ### Examples @@ -152,7 +152,7 @@ end Get Fax -Returns information about fax +Returns information about a Fax ### Examples @@ -221,7 +221,7 @@ end Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### Examples @@ -269,8 +269,8 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `page` | **Integer** | Page | [optional][default to 1] | -| `page_size` | **Integer** | Page size | [optional][default to 20] | +| `page` | **Integer** | Which page number of the Fax List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | ### Return type @@ -292,7 +292,7 @@ end Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### Examples diff --git a/sdks/ruby/docs/FaxLineAddUserRequest.md b/sdks/ruby/docs/FaxLineAddUserRequest.md index 272d38367..f5339aea7 100644 --- a/sdks/ruby/docs/FaxLineAddUserRequest.md +++ b/sdks/ruby/docs/FaxLineAddUserRequest.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | | `account_id` | ```String``` | Account ID | | | `email_address` | ```String``` | Email address | | diff --git a/sdks/ruby/docs/FaxLineApi.md b/sdks/ruby/docs/FaxLineApi.md index 49309267e..f7687b9e3 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/province and city. +Returns a list of available area codes for a given state/province and city ### Examples @@ -135,10 +135,10 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `country` | **String** | Filter area codes by country. | | -| `state` | **String** | Filter area codes by state. | [optional] | -| `province` | **String** | Filter area codes by province. | [optional] | -| `city` | **String** | Filter area codes by city. | [optional] | +| `country` | **String** | Filter area codes by country | | +| `state` | **String** | Filter area codes by state | [optional] | +| `province` | **String** | Filter area codes by province | [optional] | +| `city` | **String** | Filter area codes by city | [optional] | ### Return type @@ -160,7 +160,7 @@ end Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### Examples @@ -345,7 +345,7 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number` | **String** | The Fax Line number. | | +| `number` | **String** | The Fax Line number | | ### Return type @@ -413,9 +413,9 @@ end | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | `account_id` | **String** | Account ID | [optional] | -| `page` | **Integer** | Page | [optional][default to 1] | -| `page_size` | **Integer** | Page size | [optional][default to 20] | -| `show_team_lines` | **Boolean** | Show team lines | [optional] | +| `page` | **Integer** | Which page number of the Fax Line List to return. Defaults to `1`. | [optional][default to 1] | +| `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] | +| `show_team_lines` | **Boolean** | Include Fax Lines belonging to team members in the list | [optional] | ### Return type @@ -437,7 +437,7 @@ end Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### Examples diff --git a/sdks/ruby/docs/FaxLineCreateRequest.md b/sdks/ruby/docs/FaxLineCreateRequest.md index bbe5312c6..5359e4073 100644 --- a/sdks/ruby/docs/FaxLineCreateRequest.md +++ b/sdks/ruby/docs/FaxLineCreateRequest.md @@ -6,8 +6,8 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `area_code`*_required_ | ```Integer``` | Area code | | -| `country`*_required_ | ```String``` | Country | | -| `city` | ```String``` | City | | -| `account_id` | ```String``` | Account ID | | +| `area_code`*_required_ | ```Integer``` | Area code of the new Fax Line | | +| `country`*_required_ | ```String``` | Country of the area code | | +| `city` | ```String``` | City of the area code | | +| `account_id` | ```String``` | Account ID of the account that will be assigned this new Fax Line | | diff --git a/sdks/ruby/docs/FaxLineDeleteRequest.md b/sdks/ruby/docs/FaxLineDeleteRequest.md index 5c781f3b4..fc910e543 100644 --- a/sdks/ruby/docs/FaxLineDeleteRequest.md +++ b/sdks/ruby/docs/FaxLineDeleteRequest.md @@ -6,5 +6,5 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | diff --git a/sdks/ruby/docs/FaxLineRemoveUserRequest.md b/sdks/ruby/docs/FaxLineRemoveUserRequest.md index 98388f6f4..4156b6130 100644 --- a/sdks/ruby/docs/FaxLineRemoveUserRequest.md +++ b/sdks/ruby/docs/FaxLineRemoveUserRequest.md @@ -6,7 +6,7 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `number`*_required_ | ```String``` | The Fax Line number. | | -| `account_id` | ```String``` | Account ID | | -| `email_address` | ```String``` | Email address | | +| `number`*_required_ | ```String``` | The Fax Line number | | +| `account_id` | ```String``` | Account ID of the user to remove access | | +| `email_address` | ```String``` | Email address of the user to remove access | | diff --git a/sdks/ruby/docs/FaxSendRequest.md b/sdks/ruby/docs/FaxSendRequest.md index 6217af9f6..af96a2357 100644 --- a/sdks/ruby/docs/FaxSendRequest.md +++ b/sdks/ruby/docs/FaxSendRequest.md @@ -6,13 +6,13 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| `recipient`*_required_ | ```String``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```String``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```String``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```Array``` | Fax File to Send | | -| `file_urls` | ```Array``` | Fax File URL to Send | | +| `files` | ```Array``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `file_urls` | ```Array``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `test_mode` | ```Boolean``` | API Test Mode Setting | [default to false] | -| `cover_page_to` | ```String``` | Fax Cover Page for Recipient | | -| `cover_page_from` | ```String``` | Fax Cover Page for Sender | | +| `cover_page_to` | ```String``` | Fax cover page recipient information | | +| `cover_page_from` | ```String``` | Fax cover page sender information | | | `cover_page_message` | ```String``` | Fax Cover Page Message | | | `title` | ```String``` | Fax Title | | diff --git a/sdks/ruby/lib/dropbox-sign/api/fax_api.rb b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb index 2df3c1851..b6685eb60 100644 --- a/sdks/ruby/lib/dropbox-sign/api/fax_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/fax_api.rb @@ -23,7 +23,7 @@ def initialize(api_client = ApiClient.default) @api_client = api_client end # Delete Fax - # Deletes the specified Fax from the system. + # Deletes the specified Fax from the system # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [nil] @@ -33,7 +33,7 @@ def fax_delete(fax_id, opts = {}) end # Delete Fax - # Deletes the specified Fax from the system. + # Deletes the specified Fax from the system # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -90,7 +90,7 @@ def fax_delete_with_http_info(fax_id, opts = {}) end # Download Fax Files - # Downloads fax files + # Downloads files associated with a Fax # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [File] @@ -100,7 +100,7 @@ def fax_files(fax_id, opts = {}) end # Download Fax Files - # Downloads fax files + # Downloads files associated with a Fax # @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 @@ -184,7 +184,7 @@ def fax_files_with_http_info(fax_id, opts = {}) end # Get Fax - # Returns information about fax + # Returns information about a Fax # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [FaxGetResponse] @@ -194,7 +194,7 @@ def fax_get(fax_id, opts = {}) end # Get Fax - # Returns information about fax + # Returns information about a Fax # @param fax_id [String] Fax ID # @param [Hash] opts the optional parameters # @return [Array<(FaxGetResponse, Integer, Hash)>] FaxGetResponse data, response status code and response headers @@ -278,10 +278,10 @@ def fax_get_with_http_info(fax_id, opts = {}) end # Lists Faxes - # Returns properties of multiple faxes + # Returns properties of multiple Faxes # @param [Hash] opts the optional parameters - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) + # @option opts [Integer] :page Which page number of the Fax List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) # @return [FaxListResponse] def fax_list(opts = {}) data, _status_code, _headers = fax_list_with_http_info(opts) @@ -289,10 +289,10 @@ def fax_list(opts = {}) end # Lists Faxes - # Returns properties of multiple faxes + # Returns properties of multiple Faxes # @param [Hash] opts the optional parameters - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) + # @option opts [Integer] :page Which page number of the Fax List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) # @return [Array<(FaxListResponse, Integer, Hash)>] FaxListResponse data, response status code and response headers def fax_list_with_http_info(opts = {}) if @api_client.config.debugging @@ -384,7 +384,7 @@ def fax_list_with_http_info(opts = {}) end # Send Fax - # Action to prepare and send a fax + # Creates and sends a new Fax with the submitted file(s) # @param fax_send_request [FaxSendRequest] # @param [Hash] opts the optional parameters # @return [FaxGetResponse] @@ -394,7 +394,7 @@ def fax_send(fax_send_request, opts = {}) end # Send Fax - # Action to prepare and send a fax + # Creates and sends a new Fax with the submitted file(s) # @param fax_send_request [FaxSendRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxGetResponse, Integer, Hash)>] FaxGetResponse 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 a0b9677db..986673dcf 100644 --- a/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb +++ b/sdks/ruby/lib/dropbox-sign/api/fax_line_api.rb @@ -132,12 +132,12 @@ 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/province and city. - # @param country [String] Filter area codes by country. + # Returns a list of available area codes 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. - # @option opts [String] :province Filter area codes by province. - # @option opts [String] :city Filter area codes by city. + # @option opts [String] :state Filter area codes by state + # @option opts [String] :province Filter area codes by province + # @option opts [String] :city Filter area codes by city # @return [FaxLineAreaCodeGetResponse] def fax_line_area_code_get(country, opts = {}) data, _status_code, _headers = fax_line_area_code_get_with_http_info(country, opts) @@ -145,12 +145,12 @@ 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/province and city. - # @param country [String] Filter area codes by country. + # Returns a list of available area codes 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. - # @option opts [String] :province Filter area codes by province. - # @option opts [String] :city Filter area codes by city. + # @option opts [String] :state Filter area codes by state + # @option opts [String] :province Filter area codes by province + # @option opts [String] :city Filter area codes by city # @return [Array<(FaxLineAreaCodeGetResponse, Integer, Hash)>] FaxLineAreaCodeGetResponse data, response status code and response headers def fax_line_area_code_get_with_http_info(country, opts = {}) if @api_client.config.debugging @@ -249,7 +249,7 @@ def fax_line_area_code_get_with_http_info(country, opts = {}) end # Purchase Fax Line - # Purchases a new Fax Line. + # Purchases a new Fax Line # @param fax_line_create_request [FaxLineCreateRequest] # @param [Hash] opts the optional parameters # @return [FaxLineResponse] @@ -259,7 +259,7 @@ def fax_line_create(fax_line_create_request, opts = {}) end # Purchase Fax Line - # Purchases a new Fax Line. + # Purchases a new Fax Line # @param fax_line_create_request [FaxLineCreateRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers @@ -441,7 +441,7 @@ def fax_line_delete_with_http_info(fax_line_delete_request, opts = {}) # Get Fax Line # Returns the properties and settings of a Fax Line. - # @param number [String] The Fax Line number. + # @param number [String] The Fax Line number # @param [Hash] opts the optional parameters # @return [FaxLineResponse] def fax_line_get(number, opts = {}) @@ -451,7 +451,7 @@ def fax_line_get(number, opts = {}) # Get Fax Line # Returns the properties and settings of a Fax Line. - # @param number [String] The Fax Line number. + # @param number [String] The Fax Line number # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers def fax_line_get_with_http_info(number, opts = {}) @@ -538,9 +538,9 @@ def fax_line_get_with_http_info(number, opts = {}) # Returns the properties and settings of multiple Fax Lines. # @param [Hash] opts the optional parameters # @option opts [String] :account_id Account ID - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) - # @option opts [Boolean] :show_team_lines Show team lines + # @option opts [Integer] :page Which page number of the Fax Line List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) + # @option opts [Boolean] :show_team_lines Include Fax Lines belonging to team members in the list # @return [FaxLineListResponse] def fax_line_list(opts = {}) data, _status_code, _headers = fax_line_list_with_http_info(opts) @@ -551,9 +551,9 @@ def fax_line_list(opts = {}) # Returns the properties and settings of multiple Fax Lines. # @param [Hash] opts the optional parameters # @option opts [String] :account_id Account ID - # @option opts [Integer] :page Page (default to 1) - # @option opts [Integer] :page_size Page size (default to 20) - # @option opts [Boolean] :show_team_lines Show team lines + # @option opts [Integer] :page Which page number of the Fax Line List to return. Defaults to `1`. (default to 1) + # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20) + # @option opts [Boolean] :show_team_lines Include Fax Lines belonging to team members in the list # @return [Array<(FaxLineListResponse, Integer, Hash)>] FaxLineListResponse data, response status code and response headers def fax_line_list_with_http_info(opts = {}) if @api_client.config.debugging @@ -635,7 +635,7 @@ def fax_line_list_with_http_info(opts = {}) end # Remove Fax Line Access - # Removes a user's access to the specified Fax Line. + # Removes a user's access to the specified Fax Line # @param fax_line_remove_user_request [FaxLineRemoveUserRequest] # @param [Hash] opts the optional parameters # @return [FaxLineResponse] @@ -645,7 +645,7 @@ def fax_line_remove_user(fax_line_remove_user_request, opts = {}) end # Remove Fax Line Access - # Removes a user's access to the specified Fax Line. + # Removes a user's access to the specified Fax Line # @param fax_line_remove_user_request [FaxLineRemoveUserRequest] # @param [Hash] opts the optional parameters # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_line_add_user_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_line_add_user_request.rb index d2b04a378..37dec78c8 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_line_add_user_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_line_add_user_request.rb @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class FaxLineAddUserRequest - # The Fax Line number. + # The Fax Line number # @return [String] attr_accessor :number diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_line_create_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_line_create_request.rb index 16f9ebdde..06b6b356a 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_line_create_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_line_create_request.rb @@ -18,19 +18,19 @@ module Dropbox module Dropbox::Sign class FaxLineCreateRequest - # Area code + # Area code of the new Fax Line # @return [Integer] attr_accessor :area_code - # Country + # Country of the area code # @return [String] attr_accessor :country - # City + # City of the area code # @return [String] attr_accessor :city - # Account ID + # Account ID of the account that will be assigned this new Fax Line # @return [String] attr_accessor :account_id diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_line_delete_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_line_delete_request.rb index cdb344e44..a8fac5786 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_line_delete_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_line_delete_request.rb @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class FaxLineDeleteRequest - # The Fax Line number. + # The Fax Line number # @return [String] attr_accessor :number diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_line_remove_user_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_line_remove_user_request.rb index 3908c50fb..b6ed3e951 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_line_remove_user_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_line_remove_user_request.rb @@ -18,15 +18,15 @@ module Dropbox module Dropbox::Sign class FaxLineRemoveUserRequest - # The Fax Line number. + # The Fax Line number # @return [String] attr_accessor :number - # Account ID + # Account ID of the user to remove access # @return [String] attr_accessor :account_id - # Email address + # Email address of the user to remove access # @return [String] attr_accessor :email_address diff --git a/sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb b/sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb index 18616cee1..098737b4e 100644 --- a/sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb +++ b/sdks/ruby/lib/dropbox-sign/models/fax_send_request.rb @@ -18,7 +18,7 @@ module Dropbox module Dropbox::Sign class FaxSendRequest - # Fax Send To Recipient + # Recipient of the fax Can be a phone number in E.164 format or email address # @return [String] attr_accessor :recipient @@ -26,11 +26,11 @@ class FaxSendRequest # @return [String] attr_accessor :sender - # Fax File to Send + # Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. # @return [Array] attr_accessor :files - # Fax File URL to Send + # Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. # @return [Array] attr_accessor :file_urls @@ -38,11 +38,11 @@ class FaxSendRequest # @return [Boolean] attr_accessor :test_mode - # Fax Cover Page for Recipient + # Fax cover page recipient information # @return [String] attr_accessor :cover_page_to - # Fax Cover Page for Sender + # Fax cover page sender information # @return [String] attr_accessor :cover_page_from diff --git a/translations/en.yaml b/translations/en.yaml index 52a9b3559..e6ee3186d 100644 --- a/translations/en.yaml +++ b/translations/en.yaml @@ -131,26 +131,34 @@ "EmbeddedSignUrl::SIGNATURE_ID": The id of the signature to get a signature url for. "FaxGet::SUMMARY": Get Fax -"FaxGet::DESCRIPTION": Returns information about fax +"FaxGet::DESCRIPTION": Returns information about a Fax "FaxParam::FAX_ID": Fax ID "FaxDelete::SUMMARY": Delete Fax -"FaxDelete::DESCRIPTION": Deletes the specified Fax from the system. +"FaxDelete::DESCRIPTION": Deletes the specified Fax from the system "FaxFiles::SUMMARY": Download Fax Files -"FaxFiles::DESCRIPTION": Downloads fax files +"FaxFiles::DESCRIPTION": Downloads files associated with a Fax "FaxList::SUMMARY": Lists Faxes -"FaxList::DESCRIPTION": Returns properties of multiple faxes -"FaxList::PAGE": Page -"FaxList::PAGE_SIZE": Page size +"FaxList::DESCRIPTION": Returns properties of multiple Faxes +"FaxList::PAGE": Which page number of the Fax List to return. Defaults to `1`. +"FaxList::PAGE_SIZE": Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. "FaxSend::SUMMARY": Send Fax -"FaxSend::DESCRIPTION": Action to prepare and send a fax -"FaxSend::RECIPIENT": Fax Send To Recipient +"FaxSend::DESCRIPTION": Creates and sends a new Fax with the submitted file(s) +"FaxSend::RECIPIENT": |- + Recipient of the fax + Can be a phone number in E.164 format or email address "FaxSend::SENDER": Fax Send From Sender (used only with fax number) -"FaxSend::FILE": Fax File to Send -"FaxSend::FILE_URL": Fax File URL to Send +"FaxSend::FILE": |- + Use `files[]` to indicate the uploaded file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. +"FaxSend::FILE_URL": |- + Use `file_urls[]` to have Dropbox Fax download the file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. "FaxSend::FILE_URL_NAMES": Fax File URL Names "FaxSend::TEST_MODE": API Test Mode Setting -"FaxSend::COVER_PAGE_TO": Fax Cover Page for Recipient -"FaxSend::COVER_PAGE_FROM": Fax Cover Page for Sender +"FaxSend::COVER_PAGE_TO": Fax cover page recipient information +"FaxSend::COVER_PAGE_FROM": Fax cover page sender information "FaxSend::COVER_PAGE_MESSAGE": Fax Cover Page Message "FaxSend::TITLE": Fax Title "FaxGetResponseExample::SUMMARY": Fax Response @@ -168,41 +176,41 @@ "Sub::FaxResponseTransmission::RECIPIENT": Fax Transmission Recipient "Sub::FaxResponseTransmission::STATUS_CODE": Fax Transmission Status Code "Sub::FaxResponseTransmission::SENT_AT": Fax Transmission Sent Timestamp -"FaxListResponseExample::SUMMARY": Returns the properties and settings of multiple Faxes. +"FaxListResponseExample::SUMMARY": Returns the properties and settings of multiple Faxes "FaxLineAddUser::SUMMARY": Add Fax Line User "FaxLineAddUser::DESCRIPTION": Grants a user access to the specified Fax Line. -"FaxLineAddUser::NUMBER": The Fax Line number. +"FaxLineAddUser::NUMBER": The Fax Line number "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/province and city. -"FaxLineAreaCodeGet::CITY": Filter area codes by city. -"FaxLineAreaCodeGet::STATE": Filter area codes by state. -"FaxLineAreaCodeGet::PROVINCE": Filter area codes by province. -"FaxLineAreaCodeGet::COUNTRY": Filter area codes by country. +"FaxLineAreaCodeGet::DESCRIPTION": Returns a list of available area codes 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 +"FaxLineAreaCodeGet::COUNTRY": Filter area codes by country "FaxLineCreate::SUMMARY": Purchase Fax Line -"FaxLineCreate::DESCRIPTION": Purchases a new Fax Line. +"FaxLineCreate::DESCRIPTION": Purchases a new Fax Line "FaxLineDelete::SUMMARY": Delete Fax Line "FaxLineDelete::DESCRIPTION": Deletes the specified Fax Line from the subscription. "FaxLineGet::SUMMARY": Get Fax Line "FaxLineGet::DESCRIPTION": Returns the properties and settings of a Fax Line. -"FaxLineGet::NUMBER": The Fax Line number. +"FaxLineGet::NUMBER": The Fax Line number "FaxLineList::SUMMARY": List Fax Lines "FaxLineList::DESCRIPTION": Returns the properties and settings of multiple Fax Lines. "FaxLineList::ACCOUNT_ID": Account ID -"FaxLineList::PAGE": Page -"FaxLineList::PAGE_SIZE": Page size -"FaxLineList::SHOW_TEAM_LINES": Show team lines +"FaxLineList::PAGE": Which page number of the Fax Line List to return. Defaults to `1`. +"FaxLineList::PAGE_SIZE": Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. +"FaxLineList::SHOW_TEAM_LINES": Include Fax Lines belonging to team members in the list "FaxLineRemoveUser::SUMMARY": Remove Fax Line Access -"FaxLineRemoveUser::DESCRIPTION": Removes a user's access to the specified Fax Line. -"FaxLineRemoveUser::NUMBER": The Fax Line number. -"FaxLineRemoveUser::ACCOUNT_ID": Account ID -"FaxLineRemoveUser::EMAIL_ADDRESS": Email address -"FaxLineCreate::AREA_CODE": Area code -"FaxLineCreate::CITY": City -"FaxLineCreate::COUNTRY": Country -"FaxLineCreate::ACCOUNT_ID": Account ID -"FaxLineDelete::NUMBER": The Fax Line number. +"FaxLineRemoveUser::DESCRIPTION": Removes a user's access to the specified Fax Line +"FaxLineRemoveUser::NUMBER": The Fax Line number +"FaxLineRemoveUser::ACCOUNT_ID": Account ID of the user to remove access +"FaxLineRemoveUser::EMAIL_ADDRESS": Email address of the user to remove access +"FaxLineCreate::AREA_CODE": Area code of the new Fax Line +"FaxLineCreate::CITY": City of the area code +"FaxLineCreate::COUNTRY": Country of the area code +"FaxLineCreate::ACCOUNT_ID": Account ID of the account that will be assigned this new Fax Line +"FaxLineDelete::NUMBER": The Fax Line number "FaxLineResponseExample::SUMMARY": Sample Fax Line Response "FaxLineAreaCodeGetResponseExample::SUMMARY": Sample Area Code Response "FaxLineListResponseExample::SUMMARY": Sample Fax Line List Response @@ -1702,25 +1710,25 @@ "EmbeddedSignUrl::SEO::TITLE": "Get Embedded Sign URL | iFrame | Dropbox Sign for Developers" "EmbeddedSignUrl::SEO::DESCRIPTION": "The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here." "FaxGet::SEO::TITLE": "Get Fax | API Documentation | Dropbox Fax for Developers" -"FaxGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here." +"FaxGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve properties of a fax, click here." "FaxDelete::SEO::TITLE": "Delete Fax | API Documentation | Dropbox Fax for Developers" "FaxDelete::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax, click here." "FaxFiles::SEO::TITLE": "Fax Files | API Documentation | Dropbox Fax for Developers" -"FaxFiles::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here." +"FaxFiles::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list the files of a fax, click here." "FaxList::SEO::TITLE": "List Faxes | API Documentation | Dropbox Fax for Developers" "FaxList::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list your faxes, click here." -"FaxSend::SEO::TITLE": "Send Fax| API Documentation | Dropbox Fax for Developers" +"FaxSend::SEO::TITLE": "Send Fax | API Documentation | Dropbox Fax for Developers" "FaxSend::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here." "FaxLineAddUser::SEO::TITLE": "Fax Line Add User | API Documentation | Dropbox Fax for Developers" "FaxLineAddUser::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to add a user to an existing fax line, click here." "FaxLineAreaCodeGet::SEO::TITLE": "Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers" -"FaxLineAreaCodeGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here." +"FaxLineAreaCodeGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here." "FaxLineCreate::SEO::TITLE": "Purchase Fax Line | API Documentation | Dropbox Fax for Developers" "FaxLineCreate::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here." "FaxLineDelete::SEO::TITLE": "Delete Fax Line | API Documentation | Dropbox Fax for Developers" "FaxLineDelete::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax line, click here." "FaxLineGet::SEO::TITLE": "Get Fax Line | API Documentation | Dropbox Fax for Developers" -"FaxLineGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax line, click here." +"FaxLineGet::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here." "FaxLineList::SEO::TITLE": "List Fax Lines | API Documentation | Dropbox Fax for Developers" "FaxLineList::SEO::DESCRIPTION": "The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here." "FaxLineRemoveUser::SEO::TITLE": "Fax Line Remove User | API Documentation | Dropbox Fax for Developers"