Skip to content

Commit

Permalink
Changes by create-pull-request action (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] authored Jul 8, 2024
1 parent c662eb6 commit b9e9457
Show file tree
Hide file tree
Showing 193 changed files with 3,388 additions and 341 deletions.
129 changes: 125 additions & 4 deletions generated/Client.php
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@
use Qdequippe\Yousign\Api\Endpoint\GetWebhooks;
use Qdequippe\Yousign\Api\Endpoint\GetWebhooksWebhookId;
use Qdequippe\Yousign\Api\Endpoint\GetWorkspaces;
use Qdequippe\Yousign\Api\Endpoint\GetWorkspacesDefault;
use Qdequippe\Yousign\Api\Endpoint\GetWorkspacesWorkspaceId;
use Qdequippe\Yousign\Api\Endpoint\ListElectronicSealImages;
use Qdequippe\Yousign\Api\Endpoint\PatchContactsContactId;
use Qdequippe\Yousign\Api\Endpoint\PatchCustomExperienceLogo;
Expand All @@ -62,6 +64,7 @@
use Qdequippe\Yousign\Api\Endpoint\PatchSignatureRequestsSignatureRequestIdDocumentsDocumentId;
use Qdequippe\Yousign\Api\Endpoint\PatchSignatureRequestsSignatureRequestIdSignersSignerId;
use Qdequippe\Yousign\Api\Endpoint\PatchWebhooksWebhookId;
use Qdequippe\Yousign\Api\Endpoint\PatchWorkspacesWorkspaceId;
use Qdequippe\Yousign\Api\Endpoint\PostContact;
use Qdequippe\Yousign\Api\Endpoint\PostCustomExperience;
use Qdequippe\Yousign\Api\Endpoint\PostDocuments;
Expand All @@ -82,6 +85,7 @@
use Qdequippe\Yousign\Api\Endpoint\PostSignatureRequestsSignatureRequestIdSignersSignerIdSendReminder;
use Qdequippe\Yousign\Api\Endpoint\PostSignatureRequestsSignatureRequestIdSignersSignerIdSign;
use Qdequippe\Yousign\Api\Endpoint\PostWebhooksSubscriptions;
use Qdequippe\Yousign\Api\Endpoint\PostWorkspace;
use Qdequippe\Yousign\Api\Endpoint\PutSignatureRequestsSignatureRequestIdMetadata;
use Qdequippe\Yousign\Api\Endpoint\UpdateSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId;
use Qdequippe\Yousign\Api\Model\CreateContact;
Expand All @@ -93,8 +97,11 @@
use Qdequippe\Yousign\Api\Model\CreateSignatureRequestMetadata;
use Qdequippe\Yousign\Api\Model\CreateSignerDocumentRequest;
use Qdequippe\Yousign\Api\Model\CreateWebhookSubscription;
use Qdequippe\Yousign\Api\Model\CreateWorkspace;
use Qdequippe\Yousign\Api\Model\DeleteWorkspace;
use Qdequippe\Yousign\Api\Model\Document;
use Qdequippe\Yousign\Api\Model\Follower;
use Qdequippe\Yousign\Api\Model\MarkWorkspaceAsDefault;
use Qdequippe\Yousign\Api\Model\PatchCustomExperienceLogoRequest;
use Qdequippe\Yousign\Api\Model\PatchSignatureRequestsSignatureRequestIdApproversApproverIdRequest;
use Qdequippe\Yousign\Api\Model\PostSignatureRequestsSignatureRequestIdCancelRequest;
Expand All @@ -109,6 +116,7 @@
use Qdequippe\Yousign\Api\Model\UpdateSignatureRequestMetadata;
use Qdequippe\Yousign\Api\Model\UpdateSigner;
use Qdequippe\Yousign\Api\Model\UpdateWebhookSubscription;
use Qdequippe\Yousign\Api\Model\UpdateWorkspace;
use Qdequippe\Yousign\Api\Model\UploadElectronicSealDocument;
use Qdequippe\Yousign\Api\Model\UploadElectronicSealImage;
use Qdequippe\Yousign\Api\Model\WebhookSubscription;
Expand Down Expand Up @@ -282,18 +290,23 @@ public function getSignatureRequestsSignatureRequestIdSignersSignerIdAuditTrails

/**
* @param string $signatureRequestId Signature Request Id
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
* @param array $accept Accept content header application/zip, application/pdf|application/json
* @param array $queryParameters {
*
* @var bool $merge Download all Audit Trails merged as a single PDF file
* }
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
* @param array $accept Accept content header application/zip, application/pdf|application/json
*
* @return ResponseInterface|null
*
* @throws Exception\GetSignatureRequestsSignatureRequestIdAuditTrailsDownloadBadRequestException
* @throws Exception\GetSignatureRequestsSignatureRequestIdAuditTrailsDownloadUnauthorizedException
* @throws Exception\GetSignatureRequestsSignatureRequestIdAuditTrailsDownloadNotFoundException
*/
public function getSignatureRequestsSignatureRequestIdAuditTrailsDownload(string $signatureRequestId, string $fetch = self::FETCH_OBJECT, array $accept = [])
public function getSignatureRequestsSignatureRequestIdAuditTrailsDownload(string $signatureRequestId, array $queryParameters = [], string $fetch = self::FETCH_OBJECT, array $accept = [])
{
return $this->executeEndpoint(new GetSignatureRequestsSignatureRequestIdAuditTrailsDownload($signatureRequestId, $accept), $fetch);
return $this->executeEndpoint(new GetSignatureRequestsSignatureRequestIdAuditTrailsDownload($signatureRequestId, $queryParameters, $accept), $fetch);
}

/**
Expand Down Expand Up @@ -1399,6 +1412,114 @@ public function getWorkspaces(array $queryParameters = [], string $fetch = self:
return $this->executeEndpoint(new GetWorkspaces($queryParameters), $fetch);
}

/**
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return Model\Workspace|ResponseInterface|null
*
* @throws Exception\PostWorkspaceBadRequestException
* @throws Exception\PostWorkspaceUnauthorizedException
* @throws Exception\PostWorkspaceForbiddenException
* @throws Exception\PostWorkspaceNotFoundException
*/
public function postWorkspace(?CreateWorkspace $requestBody = null, string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new PostWorkspace($requestBody), $fetch);
}

/**
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return Model\Workspace|ResponseInterface|null
*
* @throws Exception\GetWorkspacesDefaultBadRequestException
* @throws Exception\GetWorkspacesDefaultUnauthorizedException
* @throws Exception\GetWorkspacesDefaultForbiddenException
* @throws Exception\GetWorkspacesDefaultNotFoundException
*/
public function getWorkspacesDefault(string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new GetWorkspacesDefault(), $fetch);
}

/**
* Mark the given Workspace as default. The workspace should not already be the default one and should not have been deleted.
*
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ResponseInterface|null
*
* @throws Exception\MarkWorkspaceAsDefaultBadRequestException
* @throws Exception\MarkWorkspaceAsDefaultUnauthorizedException
* @throws Exception\MarkWorkspaceAsDefaultForbiddenException
*/
public function markWorkspaceAsDefault(?MarkWorkspaceAsDefault $requestBody = null, string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new Endpoint\MarkWorkspaceAsDefault($requestBody), $fetch);
}

/**
* 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.
*
* @param string $workspaceId Workspace Id
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return ResponseInterface|null
*
* @throws Exception\DeleteWorkspaceBadRequestException
* @throws Exception\DeleteWorkspaceUnauthorizedException
* @throws Exception\DeleteWorkspaceForbiddenException
* @throws Exception\DeleteWorkspaceNotFoundException
*/
public function deleteWorkspace(string $workspaceId, ?DeleteWorkspace $requestBody = null, string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new Endpoint\DeleteWorkspace($workspaceId, $requestBody), $fetch);
}

/**
* @param string $workspaceId Workspace Id
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return Model\Workspace|ResponseInterface|null
*
* @throws Exception\GetWorkspacesWorkspaceIdBadRequestException
* @throws Exception\GetWorkspacesWorkspaceIdUnauthorizedException
* @throws Exception\GetWorkspacesWorkspaceIdForbiddenException
* @throws Exception\GetWorkspacesWorkspaceIdNotFoundException
*/
public function getWorkspacesWorkspaceId(string $workspaceId, string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new GetWorkspacesWorkspaceId($workspaceId), $fetch);
}

/**
* Update the information of a given Workspace.
*
* @param string $workspaceId Workspace Id
* @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
*
* @return Model\Workspace|ResponseInterface|null
*
* @throws Exception\PatchWorkspacesWorkspaceIdBadRequestException
* @throws Exception\PatchWorkspacesWorkspaceIdUnauthorizedException
* @throws Exception\PatchWorkspacesWorkspaceIdForbiddenException
* @throws Exception\PatchWorkspacesWorkspaceIdNotFoundException
*/
public function patchWorkspacesWorkspaceId(string $workspaceId, ?UpdateWorkspace $requestBody = null, string $fetch = self::FETCH_OBJECT)
{
return $this->executeEndpoint(new PatchWorkspacesWorkspaceId($workspaceId, $requestBody), $fetch);
}

/**
* @param array $queryParameters {
*
Expand Down
98 changes: 98 additions & 0 deletions generated/Endpoint/DeleteWorkspace.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<?php

namespace Qdequippe\Yousign\Api\Endpoint;

use Psr\Http\Message\ResponseInterface;
use Qdequippe\Yousign\Api\Exception\DeleteWorkspaceBadRequestException;
use Qdequippe\Yousign\Api\Exception\DeleteWorkspaceForbiddenException;
use Qdequippe\Yousign\Api\Exception\DeleteWorkspaceNotFoundException;
use Qdequippe\Yousign\Api\Exception\DeleteWorkspaceUnauthorizedException;
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 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.
*
* @param string $workspaceId Workspace Id
*/
public function __construct(protected string $workspaceId, ?\Qdequippe\Yousign\Api\Model\DeleteWorkspace $requestBody = null)
{
$this->body = $requestBody;
}

public function getMethod(): string
{
return 'DELETE';
}

public function getUri(): string
{
return str_replace(['{workspaceId}'], [$this->workspaceId], '/workspaces/{workspaceId}');
}

public function getBody(SerializerInterface $serializer, $streamFactory = null): array
{
if ($this->body instanceof \Qdequippe\Yousign\Api\Model\DeleteWorkspace) {
return [['Content-Type' => ['application/json']], $serializer->serialize($this->body, 'json')];
}

return [[], null];
}

public function getExtraHeaders(): array
{
return ['Accept' => ['application/json']];
}

/**
* @throws DeleteWorkspaceBadRequestException
* @throws DeleteWorkspaceUnauthorizedException
* @throws DeleteWorkspaceForbiddenException
* @throws DeleteWorkspaceNotFoundException
*/
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 DeleteWorkspaceBadRequestException($serializer->deserialize($body, ViolationResponse::class, 'json'), $response);
}
if (null !== $contentType && (401 === $status && false !== mb_strpos($contentType, 'application/json'))) {
throw new DeleteWorkspaceUnauthorizedException($serializer->deserialize($body, GetSignatureRequests401Response::class, 'json'), $response);
}
if (null !== $contentType && (403 === $status && false !== mb_strpos($contentType, 'application/json'))) {
throw new DeleteWorkspaceForbiddenException($response);
}
if (null !== $contentType && (404 === $status && false !== mb_strpos($contentType, 'application/json'))) {
throw new DeleteWorkspaceNotFoundException($response);
}

return null;
}

public function getAuthenticationScopes(): array
{
return ['bearerAuth'];
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use Qdequippe\Yousign\Api\Runtime\Client\BaseEndpoint;
use Qdequippe\Yousign\Api\Runtime\Client\Endpoint;
use Qdequippe\Yousign\Api\Runtime\Client\EndpointTrait;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Serializer\SerializerInterface;

class GetSignatureRequestsSignatureRequestIdAuditTrailsDownload extends BaseEndpoint implements Endpoint
Expand All @@ -19,10 +20,16 @@ class GetSignatureRequestsSignatureRequestIdAuditTrailsDownload extends BaseEndp

/**
* @param string $signatureRequestId Signature Request Id
* @param array $accept Accept content header application/zip, application/pdf|application/json
* @param array $queryParameters {
*
* @var bool $merge Download all Audit Trails merged as a single PDF file
* }
*
* @param array $accept Accept content header application/zip, application/pdf|application/json
*/
public function __construct(protected string $signatureRequestId, protected array $accept = [])
public function __construct(protected string $signatureRequestId, array $queryParameters = [], protected array $accept = [])
{
$this->queryParameters = $queryParameters;
}

public function getMethod(): string
Expand All @@ -49,6 +56,17 @@ public function getExtraHeaders(): array
return $this->accept;
}

protected function getQueryOptionsResolver(): OptionsResolver
{
$optionsResolver = parent::getQueryOptionsResolver();
$optionsResolver->setDefined(['merge']);
$optionsResolver->setRequired([]);
$optionsResolver->setDefaults(['merge' => false]);
$optionsResolver->addAllowedTypes('merge', ['bool']);

return $optionsResolver;
}

/**
* @throws GetSignatureRequestsSignatureRequestIdAuditTrailsDownloadBadRequestException
* @throws GetSignatureRequestsSignatureRequestIdAuditTrailsDownloadUnauthorizedException
Expand Down
Loading

0 comments on commit b9e9457

Please sign in to comment.