Skip to content

Modernized constructors and added return types for PHP compatibility #239

New issue

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

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

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.

See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.

## [V8.2.0] - eSignature API v2.1-25.1.00.02 - 2025-05-24
### Changed
- Modernized constructor classes in Api, Client and Model files (including Configuration.php file) by adding `?array $data = null` to address deprecated warnings in PHP.
- Added return types (`bool`, `mixed`, and `void`) to several functions in model files to improve type safety and compatibility with modern PHP versions.

## [v8.1.0] - eSignature API v2.1-25.1.00.02 - 2025-05-05
### Changed
- Added support for version v2.1-25.1.00.02 of the DocuSign ESignature API.
Expand Down
2 changes: 1 addition & 1 deletion src/Api/BulkProcessDataSendApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ class BulkProcessDataSendApi
*
* @return void
*/
public function __construct(ApiClient $apiClient = null)
public function __construct(?ApiClient $apiClient = null)
{
$this->apiClient = $apiClient ?? new ApiClient();
}
Expand Down
8 changes: 4 additions & 4 deletions src/Api/CommentsApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ class CommentsApi
*
* @param \DocuSign\eSign\Client\ApiClient|null $apiClient The api client to use
*/
public function __construct(\DocuSign\eSign\Client\ApiClient $apiClient = null)
public function __construct(?\DocuSign\eSign\Client\ApiClient $apiClient = null)
{
if ($apiClient === null) {
$apiClient = new ApiClient();
Expand All @@ -113,7 +113,7 @@ public function getApiClient()
*
* @return CommentsApi
*/
public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient)
public function setApiClient(?\DocuSign\eSign\Client\ApiClient $apiClient)
{
$this->apiClient = $apiClient;
return $this;
Expand All @@ -130,7 +130,7 @@ public function setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient)
* @throws \DocuSign\eSign\Client\ApiException on non-2xx response
* @return \SplFileObject
*/
public function getCommentsTranscript($account_id, $envelope_id, CommentsApi\GetCommentsTranscriptOptions $options = null)
public function getCommentsTranscript($account_id, $envelope_id, ?CommentsApi\GetCommentsTranscriptOptions $options = null)
{
list($response) = $this->getCommentsTranscriptWithHttpInfo($account_id, $envelope_id, $options);
return $response;
Expand All @@ -147,7 +147,7 @@ public function getCommentsTranscript($account_id, $envelope_id, CommentsApi\Get
* @throws \DocuSign\eSign\Client\ApiException on non-2xx response
* @return array of \SplFileObject, HTTP status code, HTTP response headers (array of strings)
*/
public function getCommentsTranscriptWithHttpInfo($account_id, $envelope_id, CommentsApi\GetCommentsTranscriptOptions $options = null)
public function getCommentsTranscriptWithHttpInfo($account_id, $envelope_id, ?CommentsApi\GetCommentsTranscriptOptions $options = null)
{
// verify the required parameter 'account_id' is set
if ($account_id === null) {
Expand Down
2 changes: 1 addition & 1 deletion src/Api/ConnectApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -595,7 +595,7 @@ class ConnectApi
*
* @return void
*/
public function __construct(ApiClient $apiClient = null)
public function __construct(?ApiClient $apiClient = null)
{
$this->apiClient = $apiClient ?? new ApiClient();
}
Expand Down
2 changes: 1 addition & 1 deletion src/Api/CustomTabsApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ class CustomTabsApi
*
* @return void
*/
public function __construct(ApiClient $apiClient = null)
public function __construct(?ApiClient $apiClient = null)
{
$this->apiClient = $apiClient ?? new ApiClient();
}
Expand Down
2 changes: 1 addition & 1 deletion src/Api/DataFeedApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ class DataFeedApi
*
* @return void
*/
public function __construct(ApiClient $apiClient = null)
public function __construct(?ApiClient $apiClient = null)
{
$this->apiClient = $apiClient ?? new ApiClient();
}
Expand Down
2 changes: 1 addition & 1 deletion src/Api/DiagnosticsApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ class DiagnosticsApi
*
* @return void
*/
public function __construct(ApiClient $apiClient = null)
public function __construct(?ApiClient $apiClient = null)
{
$this->apiClient = $apiClient ?? new ApiClient();
}
Expand Down
2 changes: 1 addition & 1 deletion src/Api/EmailArchiveApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ class EmailArchiveApi
*
* @return void
*/
public function __construct(ApiClient $apiClient = null)
public function __construct(?ApiClient $apiClient = null)
{
$this->apiClient = $apiClient ?? new ApiClient();
}
Expand Down
2 changes: 1 addition & 1 deletion src/Api/NotaryApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ class NotaryApi
*
* @return void
*/
public function __construct(ApiClient $apiClient = null)
public function __construct(?ApiClient $apiClient = null)
{
$this->apiClient = $apiClient ?? new ApiClient();
}
Expand Down
2 changes: 1 addition & 1 deletion src/Api/OrganizationsApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ class OrganizationsApi
*
* @return void
*/
public function __construct(ApiClient $apiClient = null)
public function __construct(?ApiClient $apiClient = null)
{
$this->apiClient = $apiClient ?? new ApiClient();
}
Expand Down
2 changes: 1 addition & 1 deletion src/Api/SignatureApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ class SignatureApi
* @param ApiClient|null $apiClient The api client to use
* @return void
*/
public function __construct(ApiClient $apiClient = null)
public function __construct(?ApiClient $apiClient = null)
{
$this->apiClient = $apiClient ?? new ApiClient();
}
Expand Down
6 changes: 3 additions & 3 deletions src/Api/SigningGroupsApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ class SigningGroupsApi
*
* @return void
*/
public function __construct(ApiClient $apiClient = null)
public function __construct(?ApiClient $apiClient = null)
{
$this->apiClient = $apiClient ?? new ApiClient();
}
Expand Down Expand Up @@ -192,7 +192,7 @@ public function updateResourcePath(string $resourcePath, string $baseName, strin
* @throws ApiException on non-2xx response
* @return \DocuSign\eSign\Model\SigningGroupInformation
*/
public function callList($account_id, \DocuSign\eSign\Api\SigningGroupsApi\ListOptions $options = null)
public function callList($account_id, ?\DocuSign\eSign\Api\SigningGroupsApi\ListOptions $options = null)
{
list($response) = $this->callListWithHttpInfo($account_id, $options);
return $response;
Expand All @@ -209,7 +209,7 @@ public function callList($account_id, \DocuSign\eSign\Api\SigningGroupsApi\ListO
* @throws ApiException on non-2xx response
* @return array of \DocuSign\eSign\Model\SigningGroupInformation, HTTP status code, HTTP response headers (array of strings)
*/
public function callListWithHttpInfo($account_id, \DocuSign\eSign\Api\SigningGroupsApi\ListOptions $options = null): array
public function callListWithHttpInfo($account_id, ?\DocuSign\eSign\Api\SigningGroupsApi\ListOptions $options = null): array
{
// verify the required parameter 'account_id' is set
if ($account_id === null) {
Expand Down
2 changes: 1 addition & 1 deletion src/Api/TrustServiceProvidersApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ class TrustServiceProvidersApi
*
* @return void
*/
public function __construct(ApiClient $apiClient = null)
public function __construct(?ApiClient $apiClient = null)
{
$this->apiClient = $apiClient ?? new ApiClient();
}
Expand Down
2 changes: 1 addition & 1 deletion src/Client/ApiClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ class ApiClient
* @param Configuration $config Rest API config for this ApiClient
* @param OAuth $oAuth OAuth config for this ApiClient
*/
public function __construct(Configuration $config = null, OAuth $oAuth = null)
public function __construct(?Configuration $config = null, ?OAuth $oAuth = null)
{
if ($config === null) {
$config = Configuration::getDefaultConfiguration();
Expand Down
2 changes: 1 addition & 1 deletion src/Client/Auth/Account.php
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ public static function getters()
* Constructor
* @param mixed[] $data Associated array of property values initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['account_id'] = isset($data['account_id']) ? $data['account_id'] : null;
$this->container['is_default'] = isset($data['is_default']) ? $data['is_default'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Client/Auth/Link.php
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ public static function getters()
* Constructor
* @param mixed[] $data Associated array of property values initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['rel'] = isset($data['rel']) ? $data['rel'] : null;
$this->container['href'] = isset($data['href']) ? $data['href'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Client/Auth/OAuthToken.php
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ public static function getters()
* Constructor
* @param mixed[] $data Associated array of property values initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['access_token'] = isset($data['access_token']) ? $data['access_token'] : null;
$this->container['data'] = isset($data['data']) ? $data['data'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Client/Auth/Organization.php
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ public static function getters()
* Constructor
* @param mixed[] $data Associated array of property values initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['organization_id'] = isset($data['organization_id']) ? $data['organization_id'] : null;
$this->container['links'] = isset($data['links']) ? $data['links'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Client/Auth/UserInfo.php
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ public static function getters()
* Constructor
* @param mixed[] $data Associated array of property values initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['sub'] = isset($data['sub']) ? $data['sub'] : null;
$this->container['email'] = isset($data['email']) ? $data['email'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Configuration.php
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ class Configuration
/**
* Constructor
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->tempFolderPath = sys_get_temp_dir();
if(isset($data["apiKeys"]))
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccessCodeFormat.php
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['format_required'] = isset($data['format_required']) ? $data['format_required'] : null;
$this->container['format_required_metadata'] = isset($data['format_required_metadata']) ? $data['format_required_metadata'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountAddress.php
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['address1'] = isset($data['address1']) ? $data['address1'] : null;
$this->container['address2'] = isset($data['address2']) ? $data['address2'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountBillingPlan.php
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['add_ons'] = isset($data['add_ons']) ? $data['add_ons'] : null;
$this->container['app_store_receipt_expiration_date'] = isset($data['app_store_receipt_expiration_date']) ? $data['app_store_receipt_expiration_date'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountBillingPlanResponse.php
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['billing_address'] = isset($data['billing_address']) ? $data['billing_address'] : null;
$this->container['billing_address_is_credit_card_address'] = isset($data['billing_address_is_credit_card_address']) ? $data['billing_address_is_credit_card_address'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountIdentityInputOption.php
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['is_required'] = isset($data['is_required']) ? $data['is_required'] : null;
$this->container['option_name'] = isset($data['option_name']) ? $data['option_name'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountIdentityVerificationResponse.php
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['identity_verification'] = isset($data['identity_verification']) ? $data['identity_verification'] : null;
}
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountIdentityVerificationStep.php
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['name'] = isset($data['name']) ? $data['name'] : null;
$this->container['type'] = isset($data['type']) ? $data['type'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountIdentityVerificationWorkflow.php
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['default_description'] = isset($data['default_description']) ? $data['default_description'] : null;
$this->container['default_name'] = isset($data['default_name']) ? $data['default_name'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountInformation.php
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['account_id_guid'] = isset($data['account_id_guid']) ? $data['account_id_guid'] : null;
$this->container['account_name'] = isset($data['account_name']) ? $data['account_name'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountMinimumPasswordLength.php
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['maximum_length'] = isset($data['maximum_length']) ? $data['maximum_length'] : null;
$this->container['minimum_length'] = isset($data['minimum_length']) ? $data['minimum_length'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountNotification.php
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['expirations'] = isset($data['expirations']) ? $data['expirations'] : null;
$this->container['reminders'] = isset($data['reminders']) ? $data['reminders'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountPasswordExpirePasswordDays.php
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['maximum_days'] = isset($data['maximum_days']) ? $data['maximum_days'] : null;
$this->container['minimum_days'] = isset($data['minimum_days']) ? $data['minimum_days'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountPasswordLockoutDurationMinutes.php
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['maximum_minutes'] = isset($data['maximum_minutes']) ? $data['maximum_minutes'] : null;
$this->container['minimum_minutes'] = isset($data['minimum_minutes']) ? $data['minimum_minutes'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountPasswordLockoutDurationType.php
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['options'] = isset($data['options']) ? $data['options'] : null;
}
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountPasswordMinimumPasswordAgeDays.php
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['maximum_age'] = isset($data['maximum_age']) ? $data['maximum_age'] : null;
$this->container['minimum_age'] = isset($data['minimum_age']) ? $data['minimum_age'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountPasswordQuestionsRequired.php
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['maximum_questions'] = isset($data['maximum_questions']) ? $data['maximum_questions'] : null;
$this->container['minimum_questions'] = isset($data['minimum_questions']) ? $data['minimum_questions'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountPasswordRules.php
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['expire_password'] = isset($data['expire_password']) ? $data['expire_password'] : null;
$this->container['expire_password_days'] = isset($data['expire_password_days']) ? $data['expire_password_days'] : null;
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountPasswordStrengthType.php
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['options'] = isset($data['options']) ? $data['options'] : null;
}
Expand Down
2 changes: 1 addition & 1 deletion src/Model/AccountPasswordStrengthTypeOption.php
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ public function getModelName()
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
public function __construct(?array $data = null)
{
$this->container['minimum_length'] = isset($data['minimum_length']) ? $data['minimum_length'] : null;
$this->container['name'] = isset($data['name']) ? $data['name'] : null;
Expand Down
Loading