update to docusign/esign-client 6.0

Author: Eric Tucker

bin/create-docblocs.php

@@ -115,7 +115,7 @@ function getParamType(array $parameters, string $param)
 {
     foreach ($parameters as $p) {
         if ($p->name === preg_replace('/^\$/', '', $param) && $p->hasType()) {
-            return "\\" . ((string)$p->getType());
+            return "\\" . preg_replace('/^\?/', '', (string)$p->getType());
         }
     }
 

composer.json

@@ -15,7 +15,7 @@
   "require": {
     "ext-json": "*",
     "php": "^7.3 | ^8.0",
-    "docusign/esign-client": "^5.1"
+    "docusign/esign-client": "^6.0"
   },
   "require-dev": {
     "phpunit/phpunit": "~9.5"

src/Api/Accounts.php

@@ -8,16 +8,17 @@
 /**
  * Class Authentication
  * @method Api\AuthenticationApi getClient()
- * @method \DocuSign\eSign\Client\ApiClient getApiClient() Get API client
- * @method Api\AuthenticationApi setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) Set the API client
- * @method void deleteSocialLogin(string $user_id, Models\SocialAccountInformation $social_account_information = null) Deletes user
+ * @method DocuSign\eSign\Client\ApiClient getApiClient() Get API client
+ * @method self setApiClient(ApiClient $apiClient) Set the API client
+ * @method string updateResourcePath(string $resourcePath, string $baseName, string $paramName) Update
+ * @method mixed deleteSocialLogin(?string $user_id, Models\SocialAccountInformation $social_account_information = null) Deletes user
  * @method Models\OauthAccess getOAuthToken() Creates an authorization token
- * @method Models\UserSocialIdResult listSocialLogins(string $user_id) Gets a list of a user
+ * @method Models\UserSocialIdResult listSocialLogins(?string $user_id) Gets a list of a user
  * @method Api\AuthenticationApi\LoginOptions loginOptions(array $options = ['set_api_password' => null, 'set_embed_account_id_guid' => null, 'set_include_account_id_guid' => null, 'set_login_settings' => null])
  * @method Models\LoginInformation login(Api\AuthenticationApi\LoginOptions $options = null) Gets login information for a specified user
- * @method void revokeOAuthToken() Revokes an authorization token
- * @method void updatePassword(string $login_part, Models\UserPasswordInformation $user_password_information = null) Updates the password for a specified user is supported
- * @method void updateSocialLogin(string $user_id, Models\SocialAccountInformation $social_account_information = null) Adds social account for a user
+ * @method mixed revokeOAuthToken() Revokes an authorization token
+ * @method mixed updatePassword(?string $login_part, Models\UserPasswordInformation $user_password_information = null) Updates the password for a specified user is supported
+ * @method mixed updateSocialLogin(?string $user_id, Models\SocialAccountInformation $social_account_information = null) Adds social account for a user
  */
 class Authentication extends BaseApi
 {

src/Api/Authentication.php

@@ -8,14 +8,15 @@
 /**
  * Class Billing
  * @method Api\BillingApi getClient()
- * @method \DocuSign\eSign\Client\ApiClient getApiClient() Get API client
- * @method Api\BillingApi setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) Set the API client
- * @method Models\BillingPlanResponse getBillingPlan(string $billing_plan_id) Get the billing plan details
+ * @method DocuSign\eSign\Client\ApiClient getApiClient() Get API client
+ * @method self setApiClient(ApiClient $apiClient) Set the API client
+ * @method string updateResourcePath(string $resourcePath, string $baseName, string $paramName) Update
+ * @method Models\BillingPlanResponse getBillingPlan(?string $billing_plan_id) Get the billing plan details
  * @method Models\CreditCardInformation getCreditCardInfo() Get metadata for a given credit card
  * @method Models\DowngradRequestBillingInfoResponse getDowngradeRequestBillingInfo() Returns downgrade plan information for the specified account
- * @method Models\BillingInvoice getInvoice(string $invoice_id) Retrieves a billing invoice
- * @method Models\BillingPaymentItem getPayment(string $payment_id) Gets billing payment information for a specific payment
- * @method Api\BillingApi\GetPlanOptions getPlanOptions(array $options = ['set_include_credit_card_information' => null, 'set_include_metadata' => null, 'set_include_successor_plans' => null])
+ * @method Models\BillingInvoice getInvoice(?string $invoice_id) Retrieves a billing invoice
+ * @method Models\BillingPaymentItem getPayment(?string $payment_id) Gets billing payment information for a specific payment
+ * @method Api\BillingApi\GetPlanOptions getPlanOptions(array $options = ['set_include_credit_card_information' => null, 'set_include_downgrade_information' => null, 'set_include_metadata' => null, 'set_include_successor_plans' => null])
  * @method Models\AccountBillingPlanResponse getPlan(Api\BillingApi\GetPlanOptions $options = null) Get Account Billing Plan
  * @method Models\BillingPlansResponse listBillingPlans() Gets the list of available billing plans
  * @method Api\BillingApi\ListInvoicesOptions listInvoicesOptions(array $options = ['set_from_date' => null, 'set_to_date' => null])
@@ -24,7 +25,7 @@
  * @method Api\BillingApi\ListPaymentsOptions listPaymentsOptions(array $options = ['set_from_date' => null, 'set_to_date' => null])
  * @method Models\BillingPaymentsResponse listPayments(Api\BillingApi\ListPaymentsOptions $options = null) Gets payment information for one or more payments
  * @method Models\BillingPaymentResponse makePayment(Models\BillingPaymentRequest $billing_payment_request = null) Posts a payment to a past due invoice
- * @method void purchaseEnvelopes(Models\PurchasedEnvelopesInformation $purchased_envelopes_information = null) Reserverd
+ * @method mixed purchaseEnvelopes(Models\PurchasedEnvelopesInformation $purchased_envelopes_information = null) Reserverd
  * @method Models\DowngradePlanUpdateResponse updateDowngradeAccountBillingPlan(Models\DowngradeBillingPlanInformation $downgrade_billing_plan_information = null) Queues downgrade billing plan request for an account
  * @method Api\BillingApi\UpdatePlanOptions updatePlanOptions(array $options = ['set_preview_billing_plan' => null])
  * @method Models\BillingPlanUpdateResponse updatePlan(Models\BillingPlanInformation $billing_plan_information = null, Api\BillingApi\UpdatePlanOptions $options = null) Updates the account billing plan

src/Api/Billing.php

@@ -8,31 +8,26 @@
 /**
  * Class BulkEnvelopes
  * @method Api\BulkEnvelopesApi getClient()
- * @method \DocuSign\eSign\Client\ApiClient getApiClient() Get API client
- * @method Api\BulkEnvelopesApi setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) Set the API client
- * @method Models\BulkEnvelopesResponse callList(Api\BulkEnvelopesApi\ListOptions $options = null) Gets status information about bulk recipient batches
+ * @method DocuSign\eSign\Client\ApiClient getApiClient() Get API client
+ * @method self setApiClient(ApiClient $apiClient) Set the API client
+ * @method string updateResourcePath(string $resourcePath, string $baseName, string $paramName) Update
  * @method Models\BulkSendingList createBulkSendList(Models\BulkSendingList $bulk_sending_list = null) Creates a new bulk send list
- * @method Models\BulkSendResponse createBulkSendRequest(string $bulk_send_list_id, Models\BulkSendRequest $bulk_send_request = null) Uses the specified bulk send list to send the envelope specified in the payload
- * @method Models\BulkSendTestResponse createBulkSendTestRequest(string $bulk_send_list_id, Models\BulkSendRequest $bulk_send_request = null) Tests whether the specified bulk sending list can be used to send an envelope
- * @method Models\BulkSendingListSummaries deleteBulkSendList(string $bulk_send_list_id) Deletes an existing bulk send list
- * @method Models\BulkRecipientsUpdateResponse deleteRecipients(string $envelope_id, string $recipient_id) Deletes the bulk recipient file from an envelope
- * @method Api\BulkEnvelopesApi\GetOptions getOptions(array $options = ['set_count' => null, 'set_include' => null, 'set_start_position' => null])
- * @method Models\BulkEnvelopeStatus get(string $batch_id, Api\BulkEnvelopesApi\GetOptions $options = null) Gets the status of a specified bulk send operation
- * @method Models\BulkSendBatchStatus getBulkSendBatchStatus(string $bulk_send_batch_id) Gets a specific bulk send batch status
- * @method Api\BulkEnvelopesApi\GetBulkSendBatchesOptions getBulkSendBatchesOptions(array $options = ['set_batch_ids' => null, 'set_count' => null, 'set_start_position' => null, 'set_status' => null])
+ * @method Models\BulkSendResponse createBulkSendRequest(?string $bulk_send_list_id, Models\BulkSendRequest $bulk_send_request = null) Uses the specified bulk send list to send the envelope specified in the payload
+ * @method Models\BulkSendTestResponse createBulkSendTestRequest(?string $bulk_send_list_id, Models\BulkSendRequest $bulk_send_request = null) Tests whether the specified bulk sending list can be used to send an envelope
+ * @method Models\BulkSendingListSummaries deleteBulkSendList(?string $bulk_send_list_id) Deletes an existing bulk send list
+ * @method Api\BulkEnvelopesApi\GetBulkSendBatchEnvelopesOptions getBulkSendBatchEnvelopesOptions(array $options = ['set_count' => null, 'set_include' => null, 'set_order' => null, 'set_order_by' => null, 'set_search_text' => null, 'set_start_position' => null, 'set_status' => null, 'set_user_id' => null])
+ * @method Models\EnvelopesInformation getBulkSendBatchEnvelopes(?string $bulk_send_batch_id, Api\BulkEnvelopesApi\GetBulkSendBatchEnvelopesOptions $options = null) Gets envelopes from a specific bulk send batch
+ * @method Models\BulkSendBatchStatus getBulkSendBatchStatus(?string $bulk_send_batch_id) Gets a specific bulk send batch status
+ * @method Api\BulkEnvelopesApi\GetBulkSendBatchesOptions getBulkSendBatchesOptions(array $options = ['set_batch_ids' => null, 'set_count' => null, 'set_search_text' => null, 'set_start_position' => null, 'set_status' => null])
  * @method Models\BulkSendBatchSummaries getBulkSendBatches(Api\BulkEnvelopesApi\GetBulkSendBatchesOptions $options = null) Returns a list of bulk send batch satuses initiated by account
- * @method Models\BulkSendingList getBulkSendList(string $bulk_send_list_id) Gets a specific bulk send list
+ * @method Models\BulkSendingList getBulkSendList(?string $bulk_send_list_id) Gets a specific bulk send list
  * @method Models\BulkSendingListSummaries getBulkSendLists() Lists top
- * @method Api\BulkEnvelopesApi\GetRecipientsOptions getRecipientsOptions(array $options = ['set_include_tabs' => null, 'set_start_position' => null])
- * @method Models\BulkRecipientsResponse getRecipients(string $envelope_id, string $recipient_id, Api\BulkEnvelopesApi\GetRecipientsOptions $options = null) Gets the bulk recipient file from an envelope
- * @method Models\BulkSendingList updateBulkSendList(string $bulk_send_list_id, Models\BulkSendingList $bulk_sending_list = null) Updates an existing bulk send list
- * @method Models\BulkRecipientsSummaryResponse updateRecipients(string $envelope_id, string $recipient_id, string $bulk_recipients_request) Adds or replaces envelope bulk recipients
+ * @method Models\BulkSendBatchStatus updateBulkSendBatchStatus(?string $bulk_send_batch_id, Models\BulkSendBatchRequest $bulk_send_batch_request = null) Put
+ * @method Models\BulkSendingList updateBulkSendList(?string $bulk_send_list_id, Models\BulkSendingList $bulk_sending_list = null) Updates an existing bulk send list
  */
 class BulkEnvelopes extends BaseApi
 {
     protected $methodsWithAccountId = [
-        'callList',
-        'callListWithHttpInfo',
         'createBulkSendList',
         'createBulkSendListWithHttpInfo',
         'createBulkSendRequest',
@@ -41,10 +36,8 @@ class BulkEnvelopes extends BaseApi
         'createBulkSendTestRequestWithHttpInfo',
         'deleteBulkSendList',
         'deleteBulkSendListWithHttpInfo',
-        'deleteRecipients',
-        'deleteRecipientsWithHttpInfo',
-        'get',
-        'getWithHttpInfo',
+        'getBulkSendBatchEnvelopes',
+        'getBulkSendBatchEnvelopesWithHttpInfo',
         'getBulkSendBatchStatus',
         'getBulkSendBatchStatusWithHttpInfo',
         'getBulkSendBatches',
@@ -53,11 +46,9 @@ class BulkEnvelopes extends BaseApi
         'getBulkSendListWithHttpInfo',
         'getBulkSendLists',
         'getBulkSendListsWithHttpInfo',
-        'getRecipients',
-        'getRecipientsWithHttpInfo',
+        'updateBulkSendBatchStatus',
+        'updateBulkSendBatchStatusWithHttpInfo',
         'updateBulkSendList',
-        'updateBulkSendListWithHttpInfo',
-        'updateRecipients',
-        'updateRecipientsWithHttpInfo'
+        'updateBulkSendListWithHttpInfo'
 ];
 }

src/Api/BulkEnvelopes.php

@@ -8,18 +8,19 @@
 /**
  * Class CloudStorage
  * @method Api\CloudStorageApi getClient()
- * @method \DocuSign\eSign\Client\ApiClient getApiClient() Get API client
- * @method Api\CloudStorageApi setApiClient(\DocuSign\eSign\Client\ApiClient $apiClient) Set the API client
- * @method Models\ExternalFolder callList(string $folder_id, string $service_id, string $user_id, Api\CloudStorageApi\ListOptions $options = null) Gets a list of all the items from the specified cloud storage provider
- * @method Models\CloudStorageProviders createProvider(string $user_id, Models\CloudStorageProviders $cloud_storage_providers = null) Configures the redirect URL information  for one or more cloud storage providers for the specified user
- * @method Models\CloudStorageProviders deleteProvider(string $service_id, string $user_id) Deletes the user authentication information for the specified cloud storage provider
- * @method Models\CloudStorageProviders deleteProviders(string $user_id, Models\CloudStorageProviders $cloud_storage_providers = null) Deletes the user authentication information for one or more cloud storage providers
+ * @method DocuSign\eSign\Client\ApiClient getApiClient() Get API client
+ * @method self setApiClient(ApiClient $apiClient) Set the API client
+ * @method string updateResourcePath(string $resourcePath, string $baseName, string $paramName) Update
+ * @method Models\ExternalFolder callList(?string $folder_id, ?string $service_id, ?string $user_id, Api\CloudStorageApi\ListOptions $options = null) Gets a list of all the items from the specified cloud storage provider
+ * @method Models\CloudStorageProviders createProvider(?string $user_id, Models\CloudStorageProviders $cloud_storage_providers = null) Configures the redirect URL information  for one or more cloud storage providers for the specified user
+ * @method Models\CloudStorageProviders deleteProvider(?string $service_id, ?string $user_id) Deletes the user authentication information for the specified cloud storage provider
+ * @method Models\CloudStorageProviders deleteProviders(?string $user_id, Models\CloudStorageProviders $cloud_storage_providers = null) Deletes the user authentication information for one or more cloud storage providers
  * @method Api\CloudStorageApi\GetProviderOptions getProviderOptions(array $options = ['set_redirect_url' => null])
- * @method Models\CloudStorageProviders getProvider(string $service_id, string $user_id, Api\CloudStorageApi\GetProviderOptions $options = null) Gets the specified Cloud Storage Provider configuration for the User
+ * @method Models\CloudStorageProviders getProvider(?string $service_id, ?string $user_id, Api\CloudStorageApi\GetProviderOptions $options = null) Gets the specified Cloud Storage Provider configuration for the User
  * @method Api\CloudStorageApi\ListFoldersOptions listFoldersOptions(array $options = ['set_cloud_storage_folder_path' => null, 'set_count' => null, 'set_order' => null, 'set_order_by' => null, 'set_search_text' => null, 'set_start_position' => null])
- * @method Models\ExternalFolder listFolders(string $service_id, string $user_id, Api\CloudStorageApi\ListFoldersOptions $options = null) Retrieves a list of all the items in a specified folder from the specified cloud storage provider
+ * @method Models\ExternalFolder listFolders(?string $service_id, ?string $user_id, Api\CloudStorageApi\ListFoldersOptions $options = null) Retrieves a list of all the items in a specified folder from the specified cloud storage provider
  * @method Api\CloudStorageApi\ListProvidersOptions listProvidersOptions(array $options = ['set_redirect_url' => null])
- * @method Models\CloudStorageProviders listProviders(string $user_id, Api\CloudStorageApi\ListProvidersOptions $options = null) Get the Cloud Storage Provider configuration for the specified user
+ * @method Models\CloudStorageProviders listProviders(?string $user_id, Api\CloudStorageApi\ListProvidersOptions $options = null) Get the Cloud Storage Provider configuration for the specified user
  */
 class CloudStorage extends BaseApi
 {