Changes by create-pull-request action (#19)

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)

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)

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)

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    {

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
      */

generated/Endpoint/DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace Qdequippe\Yousign\Api\Endpoint;
+
+use Psr\Http\Message\ResponseInterface;
+use Qdequippe\Yousign\Api\Exception\DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdBadRequestException;
+use Qdequippe\Yousign\Api\Exception\DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdForbiddenException;
+use Qdequippe\Yousign\Api\Exception\DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdNotFoundException;
+use Qdequippe\Yousign\Api\Exception\DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdUnauthorizedException;
+use Qdequippe\Yousign\Api\Model\GetSignatureRequests401Response;
+use Qdequippe\Yousign\Api\Model\ViolationResponse;
+use Qdequippe\Yousign\Api\Runtime\Client\BaseEndpoint;
+use Qdequippe\Yousign\Api\Runtime\Client\Endpoint;
+use Qdequippe\Yousign\Api\Runtime\Client\EndpointTrait;
+use Symfony\Component\Serializer\SerializerInterface;
+
+class DeleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId extends BaseEndpoint implements Endpoint
+{
+    use EndpointTrait;
+
+    /**
+     * 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
+     */
+    public function __construct(protected string $signatureRequestId, protected string $documentRequestId)
+    {
+    }
+
+    public function getMethod(): string
+    {
+        return 'DELETE';
+    }
+
+    public function getUri(): string
+    {
+        return str_replace(['{signatureRequestId}', '{documentRequestId}'], [$this->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'];
+    }
+}

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
      */

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

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)

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
      */

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
      */

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)

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
      */

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)

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)

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)

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)

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

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)

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
      */

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    {
      *

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    {
      *

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
      */

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    {

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

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
      *             }
      *

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)

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)

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)

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
      */

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
      */

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

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