From f682b352ab328094ade98d454764e3aadafb6d02 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 22 Jul 2024 08:33:41 +0400 Subject: [PATCH] Changes by create-pull-request action (#19) --- generated/Client.php | 181 ++++++++++++++++-- .../Endpoint/DeleteContactsContactId.php | 2 + generated/Endpoint/DeleteCustomExperience.php | 2 + .../Endpoint/DeleteCustomExperienceLogo.php | 2 + ...eteSignatureRequestsSignatureRequestId.php | 2 +- ...sSignatureRequestIdApproversApproverId.php | 2 + ...estIdDocumentRequestsDocumentRequestId.php | 84 ++++++++ ...sSignatureRequestIdDocumentsDocumentId.php | 2 + ...uestIdDocumentsDocumentIdFieldsFieldId.php | 2 +- ...tureRequestsSignatureRequestIdMetadata.php | 2 + ...uestsSignatureRequestIdSignersSignerId.php | 2 + ...atureRequestIdSignersSignerIdDocuments.php | 3 + .../Endpoint/DeleteWebhooksWebhookId.php | 2 + generated/Endpoint/DeleteWorkspace.php | 12 +- generated/Endpoint/GetContacts.php | 2 + generated/Endpoint/GetContactsContactId.php | 2 + generated/Endpoint/GetCustomExperiences.php | 3 + ...GetCustomExperiencesCustomExperienceId.php | 2 + generated/Endpoint/GetSignatureRequests.php | 2 + ...GetSignatureRequestsSignatureRequestId.php | 2 + ...sSignatureRequestIdApproversApproverId.php | 2 + ...sSignatureRequestIdAuditTrailsDownload.php | 2 + ...ureRequestsSignatureRequestIdDocuments.php | 2 + ...sSignatureRequestIdDocumentsDocumentId.php | 2 + ...tureRequestIdDocumentsDocumentIdFields.php | 2 + ...eRequestIdDocumentsDocumentsIdDownload.php | 2 + ...stsSignatureRequestIdDocumentsDownload.php | 4 +- ...ureRequestsSignatureRequestIdFollowers.php | 2 + ...tureRequestsSignatureRequestIdMetadata.php | 2 + ...atureRequestsSignatureRequestIdSigners.php | 2 + ...ureRequestIdSignersSignerIdAuditTrails.php | 2 + ...atureRequestIdSignersSignerIdDocuments.php | 3 + ...gnersSignerIdDocumentsSignerDocumentId.php | 3 + .../GetSignersSignerIdAuditTrailsDownload.php | 2 + generated/Endpoint/GetSignersSignersId.php | 2 + generated/Endpoint/GetTemplates.php | 2 + generated/Endpoint/GetUsers.php | 2 + generated/Endpoint/GetWebhooksWebhookId.php | 2 + generated/Endpoint/GetWorkspaces.php | 2 + .../Endpoint/GetWorkspacesWorkspaceId.php | 2 + generated/Endpoint/MarkWorkspaceAsDefault.php | 2 +- generated/Endpoint/PatchContactsContactId.php | 3 +- .../Endpoint/PatchCustomExperienceLogo.php | 2 + ...tchCustomExperiencesCustomExperienceId.php | 3 + ...tchSignatureRequestsSignatureRequestId.php | 2 + ...sSignatureRequestIdApproversApproverId.php | 2 + ...sSignatureRequestIdDocumentsDocumentId.php | 2 + ...uestsSignatureRequestIdSignersSignerId.php | 3 + generated/Endpoint/PatchWebhooksWebhookId.php | 3 + .../Endpoint/PatchWorkspacesWorkspaceId.php | 3 +- generated/Endpoint/PostContact.php | 3 + generated/Endpoint/PostCustomExperience.php | 3 + generated/Endpoint/PostDocuments.php | 3 + generated/Endpoint/PostSignatureRequests.php | 3 + ...tureRequestsSignatureRequestIdActivate.php | 3 + ...ureRequestsSignatureRequestIdApprovers.php | 2 +- ...natureRequestsSignatureRequestIdCancel.php | 2 + ...estsSignatureRequestIdDocumentRequests.php | 2 + ...ureRequestsSignatureRequestIdDocuments.php | 2 + ...tureRequestIdDocumentsDocumentIdFields.php | 2 + ...ureRequestIdDocumentsDocumentIdReplace.php | 2 + ...ureRequestsSignatureRequestIdFollowers.php | 2 + ...tureRequestsSignatureRequestIdMetadata.php | 2 + ...reRequestsSignatureRequestIdReactivate.php | 2 + ...atureRequestsSignatureRequestIdSigners.php | 2 + ...gnatureRequestIdSignersSignerIdSendOtp.php | 2 +- ...reRequestIdSignersSignerIdSendReminder.php | 3 + .../Endpoint/PostWebhooksSubscriptions.php | 3 + generated/Endpoint/PostWorkspace.php | 3 + ...tureRequestsSignatureRequestIdMetadata.php | 2 + ...uestIdDocumentsDocumentIdFieldsFieldId.php | 2 +- ...tsDocumentRequestIdBadRequestException.php | 24 +++ ...stsDocumentRequestIdForbiddenException.php | 21 ++ ...estsDocumentRequestIdNotFoundException.php | 21 ++ ...DocumentRequestIdUnauthorizedException.php | 24 +++ 75 files changed, 482 insertions(+), 40 deletions(-) create mode 100644 generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId.php create mode 100644 generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdBadRequestException.php create mode 100644 generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdForbiddenException.php create mode 100644 generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdNotFoundException.php create mode 100644 generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdUnauthorizedException.php diff --git a/generated/Client.php b/generated/Client.php index 03db155..80da595 100644 --- a/generated/Client.php +++ b/generated/Client.php @@ -14,6 +14,7 @@ use Qdequippe\Yousign\Api\Endpoint\DeleteElectronicSealImage; use Qdequippe\Yousign\Api\Endpoint\DeleteSignatureRequestsSignatureRequestId; use Qdequippe\Yousign\Api\Endpoint\DeleteSignatureRequestsSignatureRequestIdApproversApproverId; +use Qdequippe\Yousign\Api\Endpoint\DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId; use Qdequippe\Yousign\Api\Endpoint\DeleteSignatureRequestsSignatureRequestIdDocumentsDocumentId; use Qdequippe\Yousign\Api\Endpoint\DeleteSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId; use Qdequippe\Yousign\Api\Endpoint\DeleteSignatureRequestsSignatureRequestIdMetadata; @@ -130,6 +131,8 @@ class Client extends Runtime\Client\Client { /** + * Returns the list of all Signatures Requests in your organization. You can limit the number of items returned by using filters and pagination. + * * @param array $queryParameters { * * @var string $status Filter by status @@ -154,6 +157,8 @@ public function getSignatureRequests(array $queryParameters = [], string $fetch } /** + * Creates a new Signature Request resource. + * * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * * @return Model\SignatureRequest|ResponseInterface|null @@ -169,7 +174,7 @@ public function postSignatureRequests(?CreateSignatureRequest $requestBody = nul } /** - * Delete a Signature Request (except in approval and ongoing status). + * Deletes a given Signature Request, not possible if the Signature Request is in `approval` and `ongoing` status. * * @param string $signatureRequestId Signature Request Id * @param array $queryParameters { @@ -192,6 +197,8 @@ public function deleteSignatureRequestsSignatureRequestId(string $signatureReque } /** + * Retrieves a given Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -208,6 +215,8 @@ public function getSignatureRequestsSignatureRequestId(string $signatureRequestI } /** + * Updates a given Signature Request. Any parameters not provided are left unchanged. + * * @param string $signatureRequestId Signature Request Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -224,6 +233,9 @@ public function patchSignatureRequestsSignatureRequestId(string $signatureReques } /** + * Activates a Signature request, so it is not in `draft` status anymore. + * If the `delivery_mode` is not `null`, activating the Signature Request will trigger the notifications to Approvers/Followers/Signers. + * * @param string $signatureRequestId Signature Request Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -240,6 +252,8 @@ public function postSignatureRequestsSignatureRequestIdActivate(string $signatur } /** + * Cancels a Signature Request when it is in `approval` or `ongoing` status. A canceled Signature Request cannot be reactivated. + * * @param string $signatureRequestId Signature Request Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -256,6 +270,8 @@ public function postSignatureRequestsSignatureRequestIdCancel(string $signatureR } /** + * Reactivates a Signature Request when it is in `expired` status. + * * @param string $signatureRequestId Signature Request Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -272,6 +288,8 @@ public function postSignatureRequestsSignatureRequestIdReactivate(string $signat } /** + * Retrieves the JSON version of the Audit Trail attached to a given Signer. Only possible when Signer status is `signed`. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -289,6 +307,8 @@ public function getSignatureRequestsSignatureRequestIdSignersSignerIdAuditTrails } /** + * Download the PDF version of all the Audit Trails attached to a given Signature Request. Each Audit Trail is bound to a different Signer. Only possible when the Signature Request status is `done`. + * * @param string $signatureRequestId Signature Request Id * @param array $queryParameters { * @@ -310,6 +330,8 @@ public function getSignatureRequestsSignatureRequestIdAuditTrailsDownload(string } /** + * Download the PDF version of the Audit Trail attached to a given Signer. Only possible when Signer status is `signed`. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -328,6 +350,8 @@ public function getSignersSignerIdAuditTrailsDownload(string $signatureRequestId } /** + * Returns a list of Documents for a given Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param array $queryParameters { * @@ -349,6 +373,8 @@ public function getSignatureRequestsSignatureRequestIdDocuments(string $signatur } /** + * Adds a Document to a given Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -365,10 +391,12 @@ public function postSignatureRequestsSignatureRequestIdDocuments(string $signatu } /** + * Downloads the PDF version of all Documents attached to a given Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param array $queryParameters { * - * @var string $version specify Documents version to download, "completed" is only available when the Signature Request status is "done" + * @var string $version specify Documents version to download, `completed` is only available when the Signature Request status is `done` * @var bool $archive Force zip archive download * } * @@ -387,6 +415,8 @@ public function getSignatureRequestsSignatureRequestIdDocumentsDownload(string $ } /** + * Deletes a given Document from a Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -404,6 +434,8 @@ public function deleteSignatureRequestsSignatureRequestIdDocumentsDocumentId(str } /** + * Retrieves a given Document. + * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -420,6 +452,8 @@ public function getSignatureRequestsSignatureRequestIdDocumentsDocumentId(string } /** + * Updates a given Document. Any parameters not provided are left unchanged. + * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -437,6 +471,8 @@ public function patchSignatureRequestsSignatureRequestIdDocumentsDocumentId(stri } /** + * Downloads the PDF version of a given Document. + * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -455,6 +491,8 @@ public function getSignatureRequestsSignatureRequestIdDocumentsDocumentsIdDownlo } /** + * Replace the file of a given Document. + * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -472,6 +510,8 @@ public function postSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplac } /** + * Returns a list of Fields for a given Document. You can limit the number of items returned by using filters. + * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document ID * @param array $queryParameters { @@ -494,6 +534,8 @@ public function getSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields( } /** + * Adds a Field to a given Document. + * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document ID * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -511,7 +553,7 @@ public function postSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields } /** - * Delete a Document's Field in a Signature Request (in draft status). + * Deletes a given Field from a Document. * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document Id @@ -531,7 +573,7 @@ public function deleteSignatureRequestsSignatureRequestIdDocumentsDocumentIdFiel } /** - * Update a Document's Field in a Signature Request (in draft status). + * Updates a given Field. Any parameters not provided are left unchanged. * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document Id @@ -551,6 +593,8 @@ public function updateSignatureRequestsSignatureRequestIdDocumentsDocumentIdFiel } /** + * Adds a Signer Document Request to a given Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -567,6 +611,27 @@ public function postSignatureRequestsSignatureRequestIdDocumentRequests(string $ } /** + * Delete a Signer Document Request from signature request. This action is only permitted when the signature request is a draft. + * + * @param string $signatureRequestId Signature Request Id + * @param string $documentRequestId Signer Document Request Id + * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) + * + * @return ResponseInterface|null + * + * @throws Exception\DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdBadRequestException + * @throws Exception\DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdUnauthorizedException + * @throws Exception\DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdForbiddenException + * @throws Exception\DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdNotFoundException + */ + public function deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId(string $signatureRequestId, string $documentRequestId, string $fetch = self::FETCH_OBJECT) + { + return $this->executeEndpoint(new DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId($signatureRequestId, $documentRequestId), $fetch); + } + + /** + * Returns a list of Signers for a given Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -582,6 +647,8 @@ public function getSignatureRequestsSignatureRequestIdSigners(string $signatureR } /** + * Adds a Signer to a given Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -598,6 +665,8 @@ public function postSignatureRequestsSignatureRequestIdSigners(string $signature } /** + * Deletes a given Signer from a Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -615,6 +684,8 @@ public function deleteSignatureRequestsSignatureRequestIdSignersSignerId(string } /** + * Retrieves a given Signer. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -631,6 +702,9 @@ public function getSignersSignersId(string $signatureRequestId, string $signerId } /** + * Updates a given Signer. + * Any parameters not provided are left unchanged. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -648,7 +722,7 @@ public function patchSignatureRequestsSignatureRequestIdSignersSignerId(string $ } /** - * Send a One-Time Password (OTP) to a specified Signer. This endpoint is useful for integrating the signing flow into your application and allowing the Signer to sign through the API. Once the OTP is sent, the Signer must provide it back to complete the Signature Request. + * Send a One-Time Password (OTP) to a given Signer. Use this endpoint only if you use your own signing flow. * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id @@ -667,6 +741,9 @@ public function postSignatureRequestsSignatureRequestIdSignersSignerIdSendOtp(st } /** + * Sends a reminder to a given signer to complete their Signature Request. + * Only possible when the Signature Request status is `ongoing` and the Signer status is `notified`. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -703,6 +780,9 @@ public function postSignatureRequestsSignatureRequestIdSignersSignerIdSign(strin } /** + * Deletes all documents uploaded by a given Signer for a specific Signature Request. + * Deletion is only possible when Signer status is `signed`. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -720,6 +800,9 @@ public function deleteSignatureRequestsSignatureRequestIdSignersSignerIdDocument } /** + * Returns a list of Documents uploaded by a given Signer. + * Only possible when Signer status is `signed`. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -737,6 +820,9 @@ public function getSignatureRequestsSignatureRequestIdSignersSignerIdDocuments(s } /** + * Downloads a Document uploaded by a given Signer. + * Only possible when Signer status is `signed`. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id * @param string $signerDocumentId Signer Document Id @@ -756,7 +842,7 @@ public function getSignatureRequestsSignatureRequestIdSignersSignerIdDocumentsSi } /** - * Create a new Approver either from: - scratch - an existing Contact - an existing User - an existing Signer. + * Adds an Approver to a given Signature Request. * * @param string $signatureRequestId Signature Request Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -774,6 +860,8 @@ public function postSignatureRequestsSignatureRequestIdApprovers(string $signatu } /** + * Deletes a given Approver from a Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param string $approverId Approver Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -791,6 +879,8 @@ public function deleteSignatureRequestsSignatureRequestIdApproversApproverId(str } /** + * Retrieves a given Approver. + * * @param string $signatureRequestId Signature Request Id * @param string $approverId Approver Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -807,6 +897,8 @@ public function getSignatureRequestsSignatureRequestIdApproversApproverId(string } /** + * Updates a given Approver. Any parameters not provided are left unchanged. + * * @param string $signatureRequestId Signature Request Id * @param string $approverId Approver Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -824,6 +916,8 @@ public function patchSignatureRequestsSignatureRequestIdApproversApproverId(stri } /** + * Returns a list of Followers for a given Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -839,6 +933,8 @@ public function getSignatureRequestsSignatureRequestIdFollowers(string $signatur } /** + * Adds a Follower to a given Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param CreateFollowersInner[]|null $requestBody * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -856,6 +952,8 @@ public function postSignatureRequestsSignatureRequestIdFollowers(string $signatu } /** + * Deletes the Metadata of a given Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -871,6 +969,8 @@ public function deleteSignatureRequestsSignatureRequestIdMetadata(string $signat } /** + * Retrieves the Metadata of a given Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -886,6 +986,8 @@ public function getSignatureRequestsSignatureRequestIdMetadata(string $signature } /** + * Add Metadata to a given Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -902,6 +1004,8 @@ public function postSignatureRequestsSignatureRequestIdMetadata(string $signatur } /** + * Updates the Metadata of a given Signature Request. Any parameters not provided are left unchanged. + * * @param string $signatureRequestId Signature Request Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -918,6 +1022,9 @@ public function putSignatureRequestsSignatureRequestIdMetadata(string $signature } /** + * Returns the list of all Custom Experiences in your Organization. + * You can limit the number of items returned by using pagination. + * * @param array $queryParameters { * * @var string $after After cursor (pagination) @@ -938,6 +1045,8 @@ public function getCustomExperiences(array $queryParameters = [], string $fetch } /** + * Creates a new Custom Experience. + * * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * * @return Model\CustomExperience|ResponseInterface|null @@ -952,6 +1061,8 @@ public function postCustomExperience(?CreateCustomExperience $requestBody = null } /** + * Deletes a given Custom Experience. + * * @param string $customExperienceId Custom Experience Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -968,6 +1079,8 @@ public function deleteCustomExperience(string $customExperienceId, string $fetch } /** + * Retrieves a given Custom Experience. + * * @param string $customExperienceId Custom Experience Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -984,6 +1097,9 @@ public function getCustomExperiencesCustomExperienceId(string $customExperienceI } /** + * Updates a given Custom Experience. + * Any parameters not provided are left unchanged. + * * @param string $customExperienceId Custom Experience Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -1000,6 +1116,8 @@ public function patchCustomExperiencesCustomExperienceId(string $customExperienc } /** + * Deletes the logo of a Custom Experience. + * * @param string $customExperienceId Custom Experience Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -1016,6 +1134,8 @@ public function deleteCustomExperienceLogo(string $customExperienceId, string $f } /** + * Updates the logo of a given Custom Experience by uploading the image of your choice. + * * @param string $customExperienceId Custom Experience Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -1200,6 +1320,8 @@ public function getWebhooks(string $fetch = self::FETCH_OBJECT) } /** + * Creates a new Webhook subscription in your organization. + * * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * * @return WebhookSubscription|ResponseInterface|null @@ -1215,6 +1337,8 @@ public function postWebhooksSubscriptions(?CreateWebhookSubscription $requestBod } /** + * Deletes a given Webhook subscription. + * * @param string $webhookId Webhook Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -1231,6 +1355,8 @@ public function deleteWebhooksWebhookId(string $webhookId, string $fetch = self: } /** + * Retrieves a given Webhook subscription. + * * @param string $webhookId Webhook Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -1247,6 +1373,9 @@ public function getWebhooksWebhookId(string $webhookId, string $fetch = self::FE } /** + * Updates a given Webhook subscription. + * Any parameters not provided are left unchanged. + * * @param string $webhookId Webhook Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -1263,6 +1392,8 @@ public function patchWebhooksWebhookId(string $webhookId, ?UpdateWebhookSubscrip } /** + * Returns the list of all the Contacts within your organization. + * * @param array $queryParameters { * * @var string $after After cursor (pagination) @@ -1283,6 +1414,8 @@ public function getContacts(array $queryParameters = [], string $fetch = self::F } /** + * Creates a new Contact. + * * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * * @return Model\Contact|ResponseInterface|null @@ -1298,6 +1431,8 @@ public function postContact(?CreateContact $requestBody = null, string $fetch = } /** + * Deletes a given Contact. + * * @param string $contactId Contact Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -1313,6 +1448,8 @@ public function deleteContactsContactId(string $contactId, string $fetch = self: } /** + * Retrieves a given Contact. + * * @param string $contactId Contact Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -1326,7 +1463,8 @@ public function getContactsContactId(string $contactId, string $fetch = self::FE } /** - * Update the information of a given Contact. + * Updates a given Contact. + * Any parameters not provided are left unchanged. * * @param string $contactId Contact Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -1393,6 +1531,8 @@ public function getConsumptionsExport(array $queryParameters = [], string $fetch } /** + * Returns the list of all Workspaces within your Organization. + * * @param array $queryParameters { * * @var string $after After cursor (pagination) @@ -1413,6 +1553,8 @@ public function getWorkspaces(array $queryParameters = [], string $fetch = self: } /** + * Creates a new Workspace in the organization. + * * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * * @return Model\Workspace|ResponseInterface|null @@ -1443,7 +1585,7 @@ public function getWorkspacesDefault(string $fetch = self::FETCH_OBJECT) } /** - * Mark the given Workspace as default. The workspace should not already be the default one and should not have been deleted. + * Marks the given Workspace as default. * * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -1459,17 +1601,7 @@ public function markWorkspaceAsDefault(?MarkWorkspaceAsDefault $requestBody = nu } /** - * Delete a Workspace and migrate resources to a specified workspace. The deleted workspace should not have been migrated and should not be the default one. - * Migrated resources are: - * - BulkSendBatches - * - Contacts - * - SignatureRequests - * - Templates - * - Users (not already present in target workspace) - * - WorkflowExecutions - * - WorkflowFormQuestion - * - WorkflowsWorkspace - * - WorkspaceInvitations. + * Deletes a given Workspace and transfers everything that is attached to this Workspace to a another specified Workspace. * * @param string $workspaceId Workspace Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -1487,6 +1619,8 @@ public function deleteWorkspace(string $workspaceId, ?DeleteWorkspace $requestBo } /** + * Retrieves a given Workspace. + * * @param string $workspaceId Workspace Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * @@ -1503,7 +1637,8 @@ public function getWorkspacesWorkspaceId(string $workspaceId, string $fetch = se } /** - * Update the information of a given Workspace. + * Updates a given Workspace. + * Any parameters not provided are left unchanged. * * @param string $workspaceId Workspace Id * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) @@ -1521,6 +1656,8 @@ public function patchWorkspacesWorkspaceId(string $workspaceId, ?UpdateWorkspace } /** + * Returns the list of all the Users within your organization. + * * @param array $queryParameters { * * @var string $after After cursor (pagination) @@ -1540,6 +1677,8 @@ public function getUsers(array $queryParameters = [], string $fetch = self::FETC } /** + * Deprecated endpoint, do not use. + * * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE) * * @return Document|ResponseInterface|null @@ -1554,6 +1693,8 @@ public function postDocuments(?CreateDocument $requestBody = null, string $fetch } /** + * Returns the list of all Templates within your Organization. + * * @param array $queryParameters { * * @var string $after After cursor (pagination) diff --git a/generated/Endpoint/DeleteContactsContactId.php b/generated/Endpoint/DeleteContactsContactId.php index 47c3fa0..f50bd10 100644 --- a/generated/Endpoint/DeleteContactsContactId.php +++ b/generated/Endpoint/DeleteContactsContactId.php @@ -17,6 +17,8 @@ class DeleteContactsContactId extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Deletes a given Contact. + * * @param string $contactId Contact Id */ public function __construct(protected string $contactId) diff --git a/generated/Endpoint/DeleteCustomExperience.php b/generated/Endpoint/DeleteCustomExperience.php index 0cbdb73..b7dd200 100644 --- a/generated/Endpoint/DeleteCustomExperience.php +++ b/generated/Endpoint/DeleteCustomExperience.php @@ -19,6 +19,8 @@ class DeleteCustomExperience extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Deletes a given Custom Experience. + * * @param string $customExperienceId Custom Experience Id */ public function __construct(protected string $customExperienceId) diff --git a/generated/Endpoint/DeleteCustomExperienceLogo.php b/generated/Endpoint/DeleteCustomExperienceLogo.php index 13363bd..46a5d7e 100644 --- a/generated/Endpoint/DeleteCustomExperienceLogo.php +++ b/generated/Endpoint/DeleteCustomExperienceLogo.php @@ -19,6 +19,8 @@ class DeleteCustomExperienceLogo extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Deletes the logo of a Custom Experience. + * * @param string $customExperienceId Custom Experience Id */ public function __construct(protected string $customExperienceId) diff --git a/generated/Endpoint/DeleteSignatureRequestsSignatureRequestId.php b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestId.php index 76c181c..4de3a4f 100644 --- a/generated/Endpoint/DeleteSignatureRequestsSignatureRequestId.php +++ b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestId.php @@ -20,7 +20,7 @@ class DeleteSignatureRequestsSignatureRequestId extends BaseEndpoint implements use EndpointTrait; /** - * Delete a Signature Request (except in approval and ongoing status). + * Deletes a given Signature Request, not possible if the Signature Request is in `approval` and `ongoing` status. * * @param string $signatureRequestId Signature Request Id * @param array $queryParameters { diff --git a/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdApproversApproverId.php b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdApproversApproverId.php index 791a751..90569b4 100644 --- a/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdApproversApproverId.php +++ b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdApproversApproverId.php @@ -19,6 +19,8 @@ class DeleteSignatureRequestsSignatureRequestIdApproversApproverId extends BaseE use EndpointTrait; /** + * Deletes a given Approver from a Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param string $approverId Approver Id */ diff --git a/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId.php b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId.php new file mode 100644 index 0000000..52d6a58 --- /dev/null +++ b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId.php @@ -0,0 +1,84 @@ +signatureRequestId, $this->documentRequestId], '/signature_requests/{signatureRequestId}/document_requests/{documentRequestId}'); + } + + public function getBody(SerializerInterface $serializer, $streamFactory = null): array + { + return [[], null]; + } + + public function getExtraHeaders(): array + { + return ['Accept' => ['application/json']]; + } + + /** + * @throws DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdBadRequestException + * @throws DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdUnauthorizedException + * @throws DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdForbiddenException + * @throws DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdNotFoundException + */ + protected function transformResponseBody(ResponseInterface $response, SerializerInterface $serializer, ?string $contentType = null) + { + $status = $response->getStatusCode(); + $body = (string) $response->getBody(); + if (204 === $status) { + return null; + } + if (null !== $contentType && (400 === $status && false !== mb_strpos($contentType, 'application/json'))) { + throw new DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdBadRequestException($serializer->deserialize($body, ViolationResponse::class, 'json'), $response); + } + if (null !== $contentType && (401 === $status && false !== mb_strpos($contentType, 'application/json'))) { + throw new DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdUnauthorizedException($serializer->deserialize($body, GetSignatureRequests401Response::class, 'json'), $response); + } + if (null !== $contentType && (403 === $status && false !== mb_strpos($contentType, 'application/json'))) { + throw new DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdForbiddenException($response); + } + if (null !== $contentType && (404 === $status && false !== mb_strpos($contentType, 'application/json'))) { + throw new DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdNotFoundException($response); + } + + return null; + } + + public function getAuthenticationScopes(): array + { + return ['bearerAuth']; + } +} diff --git a/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdDocumentsDocumentId.php b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdDocumentsDocumentId.php index babf5be..0f9cb85 100644 --- a/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdDocumentsDocumentId.php +++ b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdDocumentsDocumentId.php @@ -19,6 +19,8 @@ class DeleteSignatureRequestsSignatureRequestIdDocumentsDocumentId extends BaseE use EndpointTrait; /** + * Deletes a given Document from a Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document Id */ diff --git a/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId.php b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId.php index cf8d83f..30d867a 100644 --- a/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId.php +++ b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId.php @@ -19,7 +19,7 @@ class DeleteSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId use EndpointTrait; /** - * Delete a Document's Field in a Signature Request (in draft status). + * Deletes a given Field from a Document. * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document Id diff --git a/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdMetadata.php b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdMetadata.php index 1aa4f2b..1894f11 100644 --- a/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdMetadata.php +++ b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdMetadata.php @@ -17,6 +17,8 @@ class DeleteSignatureRequestsSignatureRequestIdMetadata extends BaseEndpoint imp use EndpointTrait; /** + * Deletes the Metadata of a given Signature Request. + * * @param string $signatureRequestId Signature Request Id */ public function __construct(protected string $signatureRequestId) diff --git a/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdSignersSignerId.php b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdSignersSignerId.php index 97714f7..bc5af4d 100644 --- a/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdSignersSignerId.php +++ b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdSignersSignerId.php @@ -19,6 +19,8 @@ class DeleteSignatureRequestsSignatureRequestIdSignersSignerId extends BaseEndpo use EndpointTrait; /** + * Deletes a given Signer from a Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id */ diff --git a/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdSignersSignerIdDocuments.php b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdSignersSignerIdDocuments.php index cc316fe..86c7c76 100644 --- a/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdSignersSignerIdDocuments.php +++ b/generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdSignersSignerIdDocuments.php @@ -19,6 +19,9 @@ class DeleteSignatureRequestsSignatureRequestIdSignersSignerIdDocuments extends use EndpointTrait; /** + * Deletes all documents uploaded by a given Signer for a specific Signature Request. + * Deletion is only possible when Signer status is `signed`. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id */ diff --git a/generated/Endpoint/DeleteWebhooksWebhookId.php b/generated/Endpoint/DeleteWebhooksWebhookId.php index f494ee9..455851d 100644 --- a/generated/Endpoint/DeleteWebhooksWebhookId.php +++ b/generated/Endpoint/DeleteWebhooksWebhookId.php @@ -19,6 +19,8 @@ class DeleteWebhooksWebhookId extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Deletes a given Webhook subscription. + * * @param string $webhookId Webhook Id */ public function __construct(protected string $webhookId) diff --git a/generated/Endpoint/DeleteWorkspace.php b/generated/Endpoint/DeleteWorkspace.php index e068060..eceb48b 100644 --- a/generated/Endpoint/DeleteWorkspace.php +++ b/generated/Endpoint/DeleteWorkspace.php @@ -19,17 +19,7 @@ class DeleteWorkspace extends BaseEndpoint implements Endpoint use EndpointTrait; /** - * Delete a Workspace and migrate resources to a specified workspace. The deleted workspace should not have been migrated and should not be the default one. - * Migrated resources are: - * - BulkSendBatches - * - Contacts - * - SignatureRequests - * - Templates - * - Users (not already present in target workspace) - * - WorkflowExecutions - * - WorkflowFormQuestion - * - WorkflowsWorkspace - * - WorkspaceInvitations. + * Deletes a given Workspace and transfers everything that is attached to this Workspace to a another specified Workspace. * * @param string $workspaceId Workspace Id */ diff --git a/generated/Endpoint/GetContacts.php b/generated/Endpoint/GetContacts.php index fd0b865..563bfe8 100644 --- a/generated/Endpoint/GetContacts.php +++ b/generated/Endpoint/GetContacts.php @@ -20,6 +20,8 @@ class GetContacts extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Returns the list of all the Contacts within your organization. + * * @param array $queryParameters { * * @var string $after After cursor (pagination) diff --git a/generated/Endpoint/GetContactsContactId.php b/generated/Endpoint/GetContactsContactId.php index 0d46069..f9b07b9 100644 --- a/generated/Endpoint/GetContactsContactId.php +++ b/generated/Endpoint/GetContactsContactId.php @@ -15,6 +15,8 @@ class GetContactsContactId extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Retrieves a given Contact. + * * @param string $contactId Contact Id */ public function __construct(protected string $contactId) diff --git a/generated/Endpoint/GetCustomExperiences.php b/generated/Endpoint/GetCustomExperiences.php index 403297a..24c75e0 100644 --- a/generated/Endpoint/GetCustomExperiences.php +++ b/generated/Endpoint/GetCustomExperiences.php @@ -20,6 +20,9 @@ class GetCustomExperiences extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Returns the list of all Custom Experiences in your Organization. + * You can limit the number of items returned by using pagination. + * * @param array $queryParameters { * * @var string $after After cursor (pagination) diff --git a/generated/Endpoint/GetCustomExperiencesCustomExperienceId.php b/generated/Endpoint/GetCustomExperiencesCustomExperienceId.php index 7b673d6..ab8ea4a 100644 --- a/generated/Endpoint/GetCustomExperiencesCustomExperienceId.php +++ b/generated/Endpoint/GetCustomExperiencesCustomExperienceId.php @@ -20,6 +20,8 @@ class GetCustomExperiencesCustomExperienceId extends BaseEndpoint implements End use EndpointTrait; /** + * Retrieves a given Custom Experience. + * * @param string $customExperienceId Custom Experience Id */ public function __construct(protected string $customExperienceId) diff --git a/generated/Endpoint/GetSignatureRequests.php b/generated/Endpoint/GetSignatureRequests.php index 5dfa63c..57ebadc 100644 --- a/generated/Endpoint/GetSignatureRequests.php +++ b/generated/Endpoint/GetSignatureRequests.php @@ -20,6 +20,8 @@ class GetSignatureRequests extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Returns the list of all Signatures Requests in your organization. You can limit the number of items returned by using filters and pagination. + * * @param array $queryParameters { * * @var string $status Filter by status diff --git a/generated/Endpoint/GetSignatureRequestsSignatureRequestId.php b/generated/Endpoint/GetSignatureRequestsSignatureRequestId.php index d76515d..b9cd369 100644 --- a/generated/Endpoint/GetSignatureRequestsSignatureRequestId.php +++ b/generated/Endpoint/GetSignatureRequestsSignatureRequestId.php @@ -20,6 +20,8 @@ class GetSignatureRequestsSignatureRequestId extends BaseEndpoint implements End use EndpointTrait; /** + * Retrieves a given Signature Request. + * * @param string $signatureRequestId Signature Request Id */ public function __construct(protected string $signatureRequestId) diff --git a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdApproversApproverId.php b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdApproversApproverId.php index 49a8e82..bcb46f6 100644 --- a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdApproversApproverId.php +++ b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdApproversApproverId.php @@ -18,6 +18,8 @@ class GetSignatureRequestsSignatureRequestIdApproversApproverId extends BaseEndp use EndpointTrait; /** + * Retrieves a given Approver. + * * @param string $signatureRequestId Signature Request Id * @param string $approverId Approver Id */ diff --git a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdAuditTrailsDownload.php b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdAuditTrailsDownload.php index bdcc0ed..d6e7c77 100644 --- a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdAuditTrailsDownload.php +++ b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdAuditTrailsDownload.php @@ -19,6 +19,8 @@ class GetSignatureRequestsSignatureRequestIdAuditTrailsDownload extends BaseEndp use EndpointTrait; /** + * Download the PDF version of all the Audit Trails attached to a given Signature Request. Each Audit Trail is bound to a different Signer. Only possible when the Signature Request status is `done`. + * * @param string $signatureRequestId Signature Request Id * @param array $queryParameters { * diff --git a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocuments.php b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocuments.php index a85a253..8bdfa7b 100644 --- a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocuments.php +++ b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocuments.php @@ -21,6 +21,8 @@ class GetSignatureRequestsSignatureRequestIdDocuments extends BaseEndpoint imple use EndpointTrait; /** + * Returns a list of Documents for a given Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param array $queryParameters { * diff --git a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDocumentId.php b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDocumentId.php index 9974aa4..8aabde9 100644 --- a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDocumentId.php +++ b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDocumentId.php @@ -18,6 +18,8 @@ class GetSignatureRequestsSignatureRequestIdDocumentsDocumentId extends BaseEndp use EndpointTrait; /** + * Retrieves a given Document. + * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document Id */ diff --git a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields.php b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields.php index eefee1b..f42bbd8 100644 --- a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields.php +++ b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields.php @@ -19,6 +19,8 @@ class GetSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields extends Ba use EndpointTrait; /** + * Returns a list of Fields for a given Document. You can limit the number of items returned by using filters. + * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document ID * @param array $queryParameters { diff --git a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDocumentsIdDownload.php b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDocumentsIdDownload.php index bab2370..2e3e8bc 100644 --- a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDocumentsIdDownload.php +++ b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDocumentsIdDownload.php @@ -19,6 +19,8 @@ class GetSignatureRequestsSignatureRequestIdDocumentsDocumentsIdDownload extends use EndpointTrait; /** + * Downloads the PDF version of a given Document. + * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document Id * @param array $accept Accept content header application/pdf|application/json diff --git a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDownload.php b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDownload.php index 29b7442..102367f 100644 --- a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDownload.php +++ b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdDocumentsDownload.php @@ -19,10 +19,12 @@ class GetSignatureRequestsSignatureRequestIdDocumentsDownload extends BaseEndpoi use EndpointTrait; /** + * Downloads the PDF version of all Documents attached to a given Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param array $queryParameters { * - * @var string $version specify Documents version to download, "completed" is only available when the Signature Request status is "done" + * @var string $version specify Documents version to download, `completed` is only available when the Signature Request status is `done` * @var bool $archive Force zip archive download * } * diff --git a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdFollowers.php b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdFollowers.php index 1d65121..5609d5c 100644 --- a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdFollowers.php +++ b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdFollowers.php @@ -18,6 +18,8 @@ class GetSignatureRequestsSignatureRequestIdFollowers extends BaseEndpoint imple use EndpointTrait; /** + * Returns a list of Followers for a given Signature Request. + * * @param string $signatureRequestId Signature Request Id */ public function __construct(protected string $signatureRequestId) diff --git a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdMetadata.php b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdMetadata.php index b3c7164..8392b8e 100644 --- a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdMetadata.php +++ b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdMetadata.php @@ -18,6 +18,8 @@ class GetSignatureRequestsSignatureRequestIdMetadata extends BaseEndpoint implem use EndpointTrait; /** + * Retrieves the Metadata of a given Signature Request. + * * @param string $signatureRequestId Signature Request Id */ public function __construct(protected string $signatureRequestId) diff --git a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSigners.php b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSigners.php index 63be01a..40507ed 100644 --- a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSigners.php +++ b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSigners.php @@ -18,6 +18,8 @@ class GetSignatureRequestsSignatureRequestIdSigners extends BaseEndpoint impleme use EndpointTrait; /** + * Returns a list of Signers for a given Signature Request. + * * @param string $signatureRequestId Signature Request Id */ public function __construct(protected string $signatureRequestId) diff --git a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSignersSignerIdAuditTrails.php b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSignersSignerIdAuditTrails.php index f8879fe..859d1fb 100644 --- a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSignersSignerIdAuditTrails.php +++ b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSignersSignerIdAuditTrails.php @@ -20,6 +20,8 @@ class GetSignatureRequestsSignatureRequestIdSignersSignerIdAuditTrails extends B use EndpointTrait; /** + * Retrieves the JSON version of the Audit Trail attached to a given Signer. Only possible when Signer status is `signed`. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id */ diff --git a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSignersSignerIdDocuments.php b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSignersSignerIdDocuments.php index 987d177..f9ea6c9 100644 --- a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSignersSignerIdDocuments.php +++ b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSignersSignerIdDocuments.php @@ -20,6 +20,9 @@ class GetSignatureRequestsSignatureRequestIdSignersSignerIdDocuments extends Bas use EndpointTrait; /** + * Returns a list of Documents uploaded by a given Signer. + * Only possible when Signer status is `signed`. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id */ diff --git a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSignersSignerIdDocumentsSignerDocumentId.php b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSignersSignerIdDocumentsSignerDocumentId.php index 200acb0..da939fa 100644 --- a/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSignersSignerIdDocumentsSignerDocumentId.php +++ b/generated/Endpoint/GetSignatureRequestsSignatureRequestIdSignersSignerIdDocumentsSignerDocumentId.php @@ -19,6 +19,9 @@ class GetSignatureRequestsSignatureRequestIdSignersSignerIdDocumentsSignerDocume use EndpointTrait; /** + * Downloads a Document uploaded by a given Signer. + * Only possible when Signer status is `signed`. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id * @param string $signerDocumentId Signer Document Id diff --git a/generated/Endpoint/GetSignersSignerIdAuditTrailsDownload.php b/generated/Endpoint/GetSignersSignerIdAuditTrailsDownload.php index d1dbd80..de3de50 100644 --- a/generated/Endpoint/GetSignersSignerIdAuditTrailsDownload.php +++ b/generated/Endpoint/GetSignersSignerIdAuditTrailsDownload.php @@ -19,6 +19,8 @@ class GetSignersSignerIdAuditTrailsDownload extends BaseEndpoint implements Endp use EndpointTrait; /** + * Download the PDF version of the Audit Trail attached to a given Signer. Only possible when Signer status is `signed`. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id * @param array $accept Accept content header application/pdf|application/json diff --git a/generated/Endpoint/GetSignersSignersId.php b/generated/Endpoint/GetSignersSignersId.php index adb8d28..312063b 100644 --- a/generated/Endpoint/GetSignersSignersId.php +++ b/generated/Endpoint/GetSignersSignersId.php @@ -18,6 +18,8 @@ class GetSignersSignersId extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Retrieves a given Signer. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id */ diff --git a/generated/Endpoint/GetTemplates.php b/generated/Endpoint/GetTemplates.php index 2d05b63..9765d68 100644 --- a/generated/Endpoint/GetTemplates.php +++ b/generated/Endpoint/GetTemplates.php @@ -20,6 +20,8 @@ class GetTemplates extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Returns the list of all Templates within your Organization. + * * @param array $queryParameters { * * @var string $after After cursor (pagination) diff --git a/generated/Endpoint/GetUsers.php b/generated/Endpoint/GetUsers.php index 65addf0..2579bc4 100644 --- a/generated/Endpoint/GetUsers.php +++ b/generated/Endpoint/GetUsers.php @@ -19,6 +19,8 @@ class GetUsers extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Returns the list of all the Users within your organization. + * * @param array $queryParameters { * * @var string $after After cursor (pagination) diff --git a/generated/Endpoint/GetWebhooksWebhookId.php b/generated/Endpoint/GetWebhooksWebhookId.php index 34ffd5b..bb62d87 100644 --- a/generated/Endpoint/GetWebhooksWebhookId.php +++ b/generated/Endpoint/GetWebhooksWebhookId.php @@ -20,6 +20,8 @@ class GetWebhooksWebhookId extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Retrieves a given Webhook subscription. + * * @param string $webhookId Webhook Id */ public function __construct(protected string $webhookId) diff --git a/generated/Endpoint/GetWorkspaces.php b/generated/Endpoint/GetWorkspaces.php index 07f28af..c48e7d2 100644 --- a/generated/Endpoint/GetWorkspaces.php +++ b/generated/Endpoint/GetWorkspaces.php @@ -20,6 +20,8 @@ class GetWorkspaces extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Returns the list of all Workspaces within your Organization. + * * @param array $queryParameters { * * @var string $after After cursor (pagination) diff --git a/generated/Endpoint/GetWorkspacesWorkspaceId.php b/generated/Endpoint/GetWorkspacesWorkspaceId.php index 1773bde..9a39296 100644 --- a/generated/Endpoint/GetWorkspacesWorkspaceId.php +++ b/generated/Endpoint/GetWorkspacesWorkspaceId.php @@ -20,6 +20,8 @@ class GetWorkspacesWorkspaceId extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Retrieves a given Workspace. + * * @param string $workspaceId Workspace Id */ public function __construct(protected string $workspaceId) diff --git a/generated/Endpoint/MarkWorkspaceAsDefault.php b/generated/Endpoint/MarkWorkspaceAsDefault.php index 8f28850..877a2ab 100644 --- a/generated/Endpoint/MarkWorkspaceAsDefault.php +++ b/generated/Endpoint/MarkWorkspaceAsDefault.php @@ -18,7 +18,7 @@ class MarkWorkspaceAsDefault extends BaseEndpoint implements Endpoint use EndpointTrait; /** - * Mark the given Workspace as default. The workspace should not already be the default one and should not have been deleted. + * Marks the given Workspace as default. */ public function __construct(?\Qdequippe\Yousign\Api\Model\MarkWorkspaceAsDefault $requestBody = null) { diff --git a/generated/Endpoint/PatchContactsContactId.php b/generated/Endpoint/PatchContactsContactId.php index dab4ef8..49e0e93 100644 --- a/generated/Endpoint/PatchContactsContactId.php +++ b/generated/Endpoint/PatchContactsContactId.php @@ -21,7 +21,8 @@ class PatchContactsContactId extends BaseEndpoint implements Endpoint use EndpointTrait; /** - * Update the information of a given Contact. + * Updates a given Contact. + * Any parameters not provided are left unchanged. * * @param string $contactId Contact Id */ diff --git a/generated/Endpoint/PatchCustomExperienceLogo.php b/generated/Endpoint/PatchCustomExperienceLogo.php index 2e5509e..3835e03 100644 --- a/generated/Endpoint/PatchCustomExperienceLogo.php +++ b/generated/Endpoint/PatchCustomExperienceLogo.php @@ -21,6 +21,8 @@ class PatchCustomExperienceLogo extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Updates the logo of a given Custom Experience by uploading the image of your choice. + * * @param string $customExperienceId Custom Experience Id */ public function __construct(protected string $customExperienceId, ?PatchCustomExperienceLogoRequest $requestBody = null) diff --git a/generated/Endpoint/PatchCustomExperiencesCustomExperienceId.php b/generated/Endpoint/PatchCustomExperiencesCustomExperienceId.php index 17b220c..70351e1 100644 --- a/generated/Endpoint/PatchCustomExperiencesCustomExperienceId.php +++ b/generated/Endpoint/PatchCustomExperiencesCustomExperienceId.php @@ -21,6 +21,9 @@ class PatchCustomExperiencesCustomExperienceId extends BaseEndpoint implements E use EndpointTrait; /** + * Updates a given Custom Experience. + * Any parameters not provided are left unchanged. + * * @param string $customExperienceId Custom Experience Id */ public function __construct(protected string $customExperienceId, ?UpdateCustomExperience $requestBody = null) diff --git a/generated/Endpoint/PatchSignatureRequestsSignatureRequestId.php b/generated/Endpoint/PatchSignatureRequestsSignatureRequestId.php index 822802a..2b78a35 100644 --- a/generated/Endpoint/PatchSignatureRequestsSignatureRequestId.php +++ b/generated/Endpoint/PatchSignatureRequestsSignatureRequestId.php @@ -21,6 +21,8 @@ class PatchSignatureRequestsSignatureRequestId extends BaseEndpoint implements E use EndpointTrait; /** + * Updates a given Signature Request. Any parameters not provided are left unchanged. + * * @param string $signatureRequestId Signature Request Id */ public function __construct(protected string $signatureRequestId, ?UpdateSignatureRequest $requestBody = null) diff --git a/generated/Endpoint/PatchSignatureRequestsSignatureRequestIdApproversApproverId.php b/generated/Endpoint/PatchSignatureRequestsSignatureRequestIdApproversApproverId.php index 0392e4a..47fe86b 100644 --- a/generated/Endpoint/PatchSignatureRequestsSignatureRequestIdApproversApproverId.php +++ b/generated/Endpoint/PatchSignatureRequestsSignatureRequestIdApproversApproverId.php @@ -21,6 +21,8 @@ class PatchSignatureRequestsSignatureRequestIdApproversApproverId extends BaseEn use EndpointTrait; /** + * Updates a given Approver. Any parameters not provided are left unchanged. + * * @param string $signatureRequestId Signature Request Id * @param string $approverId Approver Id */ diff --git a/generated/Endpoint/PatchSignatureRequestsSignatureRequestIdDocumentsDocumentId.php b/generated/Endpoint/PatchSignatureRequestsSignatureRequestIdDocumentsDocumentId.php index 94917bd..32f93d3 100644 --- a/generated/Endpoint/PatchSignatureRequestsSignatureRequestIdDocumentsDocumentId.php +++ b/generated/Endpoint/PatchSignatureRequestsSignatureRequestIdDocumentsDocumentId.php @@ -21,6 +21,8 @@ class PatchSignatureRequestsSignatureRequestIdDocumentsDocumentId extends BaseEn use EndpointTrait; /** + * Updates a given Document. Any parameters not provided are left unchanged. + * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document Id */ diff --git a/generated/Endpoint/PatchSignatureRequestsSignatureRequestIdSignersSignerId.php b/generated/Endpoint/PatchSignatureRequestsSignatureRequestIdSignersSignerId.php index 2816021..74e5ea4 100644 --- a/generated/Endpoint/PatchSignatureRequestsSignatureRequestIdSignersSignerId.php +++ b/generated/Endpoint/PatchSignatureRequestsSignatureRequestIdSignersSignerId.php @@ -21,6 +21,9 @@ class PatchSignatureRequestsSignatureRequestIdSignersSignerId extends BaseEndpoi use EndpointTrait; /** + * Updates a given Signer. + * Any parameters not provided are left unchanged. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id */ diff --git a/generated/Endpoint/PatchWebhooksWebhookId.php b/generated/Endpoint/PatchWebhooksWebhookId.php index d39ff55..49f1cd1 100644 --- a/generated/Endpoint/PatchWebhooksWebhookId.php +++ b/generated/Endpoint/PatchWebhooksWebhookId.php @@ -21,6 +21,9 @@ class PatchWebhooksWebhookId extends BaseEndpoint implements Endpoint use EndpointTrait; /** + * Updates a given Webhook subscription. + * Any parameters not provided are left unchanged. + * * @param string $webhookId Webhook Id */ public function __construct(protected string $webhookId, ?UpdateWebhookSubscription $requestBody = null) diff --git a/generated/Endpoint/PatchWorkspacesWorkspaceId.php b/generated/Endpoint/PatchWorkspacesWorkspaceId.php index 106262f..429935e 100644 --- a/generated/Endpoint/PatchWorkspacesWorkspaceId.php +++ b/generated/Endpoint/PatchWorkspacesWorkspaceId.php @@ -21,7 +21,8 @@ class PatchWorkspacesWorkspaceId extends BaseEndpoint implements Endpoint use EndpointTrait; /** - * Update the information of a given Workspace. + * Updates a given Workspace. + * Any parameters not provided are left unchanged. * * @param string $workspaceId Workspace Id */ diff --git a/generated/Endpoint/PostContact.php b/generated/Endpoint/PostContact.php index 909281f..14cde4a 100644 --- a/generated/Endpoint/PostContact.php +++ b/generated/Endpoint/PostContact.php @@ -20,6 +20,9 @@ class PostContact extends BaseEndpoint implements Endpoint { use EndpointTrait; + /** + * Creates a new Contact. + */ public function __construct(?CreateContact $requestBody = null) { $this->body = $requestBody; diff --git a/generated/Endpoint/PostCustomExperience.php b/generated/Endpoint/PostCustomExperience.php index d690567..daec586 100644 --- a/generated/Endpoint/PostCustomExperience.php +++ b/generated/Endpoint/PostCustomExperience.php @@ -19,6 +19,9 @@ class PostCustomExperience extends BaseEndpoint implements Endpoint { use EndpointTrait; + /** + * Creates a new Custom Experience. + */ public function __construct(?CreateCustomExperience $requestBody = null) { $this->body = $requestBody; diff --git a/generated/Endpoint/PostDocuments.php b/generated/Endpoint/PostDocuments.php index f96d7a0..4716e15 100644 --- a/generated/Endpoint/PostDocuments.php +++ b/generated/Endpoint/PostDocuments.php @@ -20,6 +20,9 @@ class PostDocuments extends BaseEndpoint implements Endpoint { use EndpointTrait; + /** + * Deprecated endpoint, do not use. + */ public function __construct(?CreateDocument $requestBody = null) { $this->body = $requestBody; diff --git a/generated/Endpoint/PostSignatureRequests.php b/generated/Endpoint/PostSignatureRequests.php index a7a95b2..0de73f6 100644 --- a/generated/Endpoint/PostSignatureRequests.php +++ b/generated/Endpoint/PostSignatureRequests.php @@ -20,6 +20,9 @@ class PostSignatureRequests extends BaseEndpoint implements Endpoint { use EndpointTrait; + /** + * Creates a new Signature Request resource. + */ public function __construct(?CreateSignatureRequest $requestBody = null) { $this->body = $requestBody; diff --git a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdActivate.php b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdActivate.php index f3c98d0..e49f397 100644 --- a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdActivate.php +++ b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdActivate.php @@ -20,6 +20,9 @@ class PostSignatureRequestsSignatureRequestIdActivate extends BaseEndpoint imple use EndpointTrait; /** + * Activates a Signature request, so it is not in `draft` status anymore. + * If the `delivery_mode` is not `null`, activating the Signature Request will trigger the notifications to Approvers/Followers/Signers. + * * @param string $signatureRequestId Signature Request Id */ public function __construct(protected string $signatureRequestId) diff --git a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdApprovers.php b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdApprovers.php index e37cd97..c8943ec 100644 --- a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdApprovers.php +++ b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdApprovers.php @@ -20,7 +20,7 @@ class PostSignatureRequestsSignatureRequestIdApprovers extends BaseEndpoint impl use EndpointTrait; /** - * Create a new Approver either from: - scratch - an existing Contact - an existing User - an existing Signer. + * Adds an Approver to a given Signature Request. * * @param string $signatureRequestId Signature Request Id */ diff --git a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdCancel.php b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdCancel.php index 7e5cbd0..1e0c6c8 100644 --- a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdCancel.php +++ b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdCancel.php @@ -21,6 +21,8 @@ class PostSignatureRequestsSignatureRequestIdCancel extends BaseEndpoint impleme use EndpointTrait; /** + * Cancels a Signature Request when it is in `approval` or `ongoing` status. A canceled Signature Request cannot be reactivated. + * * @param string $signatureRequestId Signature Request Id */ public function __construct(protected string $signatureRequestId, ?PostSignatureRequestsSignatureRequestIdCancelRequest $requestBody = null) diff --git a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocumentRequests.php b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocumentRequests.php index b2e74c0..a8324dc 100644 --- a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocumentRequests.php +++ b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocumentRequests.php @@ -21,6 +21,8 @@ class PostSignatureRequestsSignatureRequestIdDocumentRequests extends BaseEndpoi use EndpointTrait; /** + * Adds a Signer Document Request to a given Signature Request. + * * @param string $signatureRequestId Signature Request Id */ public function __construct(protected string $signatureRequestId, ?CreateSignerDocumentRequest $requestBody = null) diff --git a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocuments.php b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocuments.php index e26226d..7b6a60b 100644 --- a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocuments.php +++ b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocuments.php @@ -22,6 +22,8 @@ class PostSignatureRequestsSignatureRequestIdDocuments extends BaseEndpoint impl use EndpointTrait; /** + * Adds a Document to a given Signature Request. + * * @param string $signatureRequestId Signature Request Id */ public function __construct(protected string $signatureRequestId, ?CreateDocument $requestBody = null) diff --git a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields.php b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields.php index e46f95d..2693123 100644 --- a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields.php +++ b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields.php @@ -19,6 +19,8 @@ class PostSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields extends B use EndpointTrait; /** + * Adds a Field to a given Document. + * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document ID */ diff --git a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplace.php b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplace.php index f74b1ab..5b40b8f 100644 --- a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplace.php +++ b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplace.php @@ -22,6 +22,8 @@ class PostSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplace extends use EndpointTrait; /** + * Replace the file of a given Document. + * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document Id */ diff --git a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdFollowers.php b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdFollowers.php index 33d340e..df8be3c 100644 --- a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdFollowers.php +++ b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdFollowers.php @@ -21,6 +21,8 @@ class PostSignatureRequestsSignatureRequestIdFollowers extends BaseEndpoint impl use EndpointTrait; /** + * Adds a Follower to a given Signature Request. + * * @param string $signatureRequestId Signature Request Id * @param CreateFollowersInner[]|null $requestBody */ diff --git a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdMetadata.php b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdMetadata.php index bbc3627..5df01f7 100644 --- a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdMetadata.php +++ b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdMetadata.php @@ -21,6 +21,8 @@ class PostSignatureRequestsSignatureRequestIdMetadata extends BaseEndpoint imple use EndpointTrait; /** + * Add Metadata to a given Signature Request. + * * @param string $signatureRequestId Signature Request Id */ public function __construct(protected string $signatureRequestId, ?CreateSignatureRequestMetadata $requestBody = null) diff --git a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdReactivate.php b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdReactivate.php index 346899e..5beeef8 100644 --- a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdReactivate.php +++ b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdReactivate.php @@ -21,6 +21,8 @@ class PostSignatureRequestsSignatureRequestIdReactivate extends BaseEndpoint imp use EndpointTrait; /** + * Reactivates a Signature Request when it is in `expired` status. + * * @param string $signatureRequestId Signature Request Id */ public function __construct(protected string $signatureRequestId, ?PostSignatureRequestsSignatureRequestIdReactivateRequest $requestBody = null) diff --git a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdSigners.php b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdSigners.php index 656986d..60929ad 100644 --- a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdSigners.php +++ b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdSigners.php @@ -20,6 +20,8 @@ class PostSignatureRequestsSignatureRequestIdSigners extends BaseEndpoint implem use EndpointTrait; /** + * Adds a Signer to a given Signature Request. + * * @param string $signatureRequestId Signature Request Id */ public function __construct(protected string $signatureRequestId, ?\stdClass $requestBody = null) diff --git a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdSignersSignerIdSendOtp.php b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdSignersSignerIdSendOtp.php index 2e28d5b..418f360 100644 --- a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdSignersSignerIdSendOtp.php +++ b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdSignersSignerIdSendOtp.php @@ -19,7 +19,7 @@ class PostSignatureRequestsSignatureRequestIdSignersSignerIdSendOtp extends Base use EndpointTrait; /** - * Send a One-Time Password (OTP) to a specified Signer. This endpoint is useful for integrating the signing flow into your application and allowing the Signer to sign through the API. Once the OTP is sent, the Signer must provide it back to complete the Signature Request. + * Send a One-Time Password (OTP) to a given Signer. Use this endpoint only if you use your own signing flow. * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id diff --git a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdSignersSignerIdSendReminder.php b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdSignersSignerIdSendReminder.php index 5421dc8..af4a913 100644 --- a/generated/Endpoint/PostSignatureRequestsSignatureRequestIdSignersSignerIdSendReminder.php +++ b/generated/Endpoint/PostSignatureRequestsSignatureRequestIdSignersSignerIdSendReminder.php @@ -19,6 +19,9 @@ class PostSignatureRequestsSignatureRequestIdSignersSignerIdSendReminder extends use EndpointTrait; /** + * Sends a reminder to a given signer to complete their Signature Request. + * Only possible when the Signature Request status is `ongoing` and the Signer status is `notified`. + * * @param string $signatureRequestId Signature Request Id * @param string $signerId Signer Id */ diff --git a/generated/Endpoint/PostWebhooksSubscriptions.php b/generated/Endpoint/PostWebhooksSubscriptions.php index 2a36f4d..beb2f8d 100644 --- a/generated/Endpoint/PostWebhooksSubscriptions.php +++ b/generated/Endpoint/PostWebhooksSubscriptions.php @@ -20,6 +20,9 @@ class PostWebhooksSubscriptions extends BaseEndpoint implements Endpoint { use EndpointTrait; + /** + * Creates a new Webhook subscription in your organization. + */ public function __construct(?CreateWebhookSubscription $requestBody = null) { $this->body = $requestBody; diff --git a/generated/Endpoint/PostWorkspace.php b/generated/Endpoint/PostWorkspace.php index 29c592d..02666ae 100644 --- a/generated/Endpoint/PostWorkspace.php +++ b/generated/Endpoint/PostWorkspace.php @@ -20,6 +20,9 @@ class PostWorkspace extends BaseEndpoint implements Endpoint { use EndpointTrait; + /** + * Creates a new Workspace in the organization. + */ public function __construct(?CreateWorkspace $requestBody = null) { $this->body = $requestBody; diff --git a/generated/Endpoint/PutSignatureRequestsSignatureRequestIdMetadata.php b/generated/Endpoint/PutSignatureRequestsSignatureRequestIdMetadata.php index d573288..42a7673 100644 --- a/generated/Endpoint/PutSignatureRequestsSignatureRequestIdMetadata.php +++ b/generated/Endpoint/PutSignatureRequestsSignatureRequestIdMetadata.php @@ -21,6 +21,8 @@ class PutSignatureRequestsSignatureRequestIdMetadata extends BaseEndpoint implem use EndpointTrait; /** + * Updates the Metadata of a given Signature Request. Any parameters not provided are left unchanged. + * * @param string $signatureRequestId Signature Request Id */ public function __construct(protected string $signatureRequestId, ?UpdateSignatureRequestMetadata $requestBody = null) diff --git a/generated/Endpoint/UpdateSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId.php b/generated/Endpoint/UpdateSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId.php index ef7fddc..bffbf47 100644 --- a/generated/Endpoint/UpdateSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId.php +++ b/generated/Endpoint/UpdateSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId.php @@ -19,7 +19,7 @@ class UpdateSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId use EndpointTrait; /** - * Update a Document's Field in a Signature Request (in draft status). + * Updates a given Field. Any parameters not provided are left unchanged. * * @param string $signatureRequestId Signature Request Id * @param string $documentId Document Id diff --git a/generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdBadRequestException.php b/generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdBadRequestException.php new file mode 100644 index 0000000..136f333 --- /dev/null +++ b/generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdBadRequestException.php @@ -0,0 +1,24 @@ +violationResponse; + } + + public function getResponse(): ResponseInterface + { + return $this->response; + } +} diff --git a/generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdForbiddenException.php b/generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdForbiddenException.php new file mode 100644 index 0000000..6fe1b63 --- /dev/null +++ b/generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdForbiddenException.php @@ -0,0 +1,21 @@ +response; + } +} diff --git a/generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdNotFoundException.php b/generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdNotFoundException.php new file mode 100644 index 0000000..90ce460 --- /dev/null +++ b/generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdNotFoundException.php @@ -0,0 +1,21 @@ +response; + } +} diff --git a/generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdUnauthorizedException.php b/generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdUnauthorizedException.php new file mode 100644 index 0000000..e62153b --- /dev/null +++ b/generated/Exception/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdUnauthorizedException.php @@ -0,0 +1,24 @@ +getSignatureRequests401Response; + } + + public function getResponse(): ResponseInterface + { + return $this->response; + } +}