Download the PHP package vigicorp/yousign-api-v3 without Composer
On this page you can find all versions of the php package vigicorp/yousign-api-v3. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vigicorp/yousign-api-v3
More information about vigicorp/yousign-api-v3
Files in vigicorp/yousign-api-v3
Package yousign-api-v3
Short Description Build the best experience of digital signature through your own platform. Increase your conversion rates, leverage your data and reduce your costs with Yousign API.
License MIT
Homepage https://openapi-generator.tech
Informations about the package yousign-api-v3
OpenAPIClient-php
Build the best experience of digital signature through your own platform. Increase your conversion rates, leverage your data and reduce your costs with Yousign API.
Installation & Usage
Requirements
PHP 7.4 and later. Should also work with PHP 8.0.
Composer
To install the bindings via Composer, add the following to composer.json
:
Then run composer install
Manual Installation
Download the files and include autoload.php
:
Getting Started
Please follow the installation procedure and then run the following:
API Endpoints
All URIs are relative to https://api-sandbox.yousign.app/v3
Class | Method | HTTP request | Description |
---|---|---|---|
ApproverApi | deleteSignatureRequestsSignatureRequestIdApproversApproverId | DELETE /signature_requests/{signatureRequestId}/approvers/{approverId} | Delete an Approver |
ApproverApi | getSignatureRequestsSignatureRequestIdApproversApproverId | GET /signature_requests/{signatureRequestId}/approvers/{approverId} | Get an Approver |
ApproverApi | patchSignatureRequestsSignatureRequestIdApproversApproverId | PATCH /signature_requests/{signatureRequestId}/approvers/{approverId} | Update an Approver |
ApproverApi | postSignatureRequestsSignatureRequestIdApprovers | POST /signature_requests/{signatureRequestId}/approvers | Create a new Approver |
ApproverApi | postSignatureRequestsSignatureRequestIdApproversApproverIdSendReminder | POST /signature_requests/{signatureRequestId}/approvers/{approverId}/send_reminder | Send manual reminder to an Approver |
ArchiveApi | getArchivesArchivedFileIdDownload | GET /archives/{archivedFileId}/download | Download archived file |
ArchiveApi | postArchives | POST /archives | Direct upload an archived file |
AuditTrailApi | getSignatureRequestsSignatureRequestIdAuditTrailsDownload | GET /signature_requests/{signatureRequestId}/audit_trails/download | Download Signature Request Audit Trails |
AuditTrailApi | getSignatureRequestsSignatureRequestIdSignersSignerIdAuditTrails | GET /signature_requests/{signatureRequestId}/signers/{signerId}/audit_trails | Get Signer Audit Trail |
AuditTrailApi | getSignersSignerIdAuditTrailsDownload | GET /signature_requests/{signatureRequestId}/signers/{signerId}/audit_trails/download | Download Audit Trail PDF |
ConsumptionApi | getConsumptions | GET /consumptions | Get Consumptions |
ConsumptionApi | getConsumptionsExport | GET /consumptions/export | Export Consumption data |
ContactApi | deleteContactsContactId | DELETE /contacts/{contactId} | Delete a Contact |
ContactApi | getContacts | GET /contacts | List Contacts |
ContactApi | getContactsContactId | GET /contacts/{contactId} | Get a Contact |
ContactApi | patchContactsContactId | PATCH /contacts/{contactId} | Update a Contact |
ContactApi | postContact | POST /contacts | Create a Contact |
CustomExperienceApi | deleteCustomExperience | DELETE /custom_experiences/{customExperienceId} | Delete a Custom Experience |
CustomExperienceApi | deleteCustomExperienceLogo | DELETE /custom_experiences/{customExperienceId}/logo | Delete a Custom Experience logo |
CustomExperienceApi | getCustomExperiences | GET /custom_experiences | List Custom Experiences |
CustomExperienceApi | getCustomExperiencesCustomExperienceId | GET /custom_experiences/{customExperienceId} | Get a Custom Experience |
CustomExperienceApi | patchCustomExperienceLogo | POST /custom_experiences/{customExperienceId}/logo | Update a Custom Experience logo |
CustomExperienceApi | patchCustomExperiencesCustomExperienceId | PATCH /custom_experiences/{customExperienceId} | Update a Custom Experience |
CustomExperienceApi | postCustomExperience | POST /custom_experiences | Create a Custom Experience |
DocumentApi | deleteSignatureRequestsSignatureRequestIdDocumentsDocumentId | DELETE /signature_requests/{signatureRequestId}/documents/{documentId} | Delete a Document |
DocumentApi | getSignatureRequestsSignatureRequestIdDocuments | GET /signature_requests/{signatureRequestId}/documents | List Signature Request's Documents |
DocumentApi | getSignatureRequestsSignatureRequestIdDocumentsDocumentId | GET /signature_requests/{signatureRequestId}/documents/{documentId} | Get a Document |
DocumentApi | getSignatureRequestsSignatureRequestIdDocumentsDocumentsIdDownload | GET /signature_requests/{signatureRequestId}/documents/{documentId}/download | Download a single Signature Request's Document |
DocumentApi | getSignatureRequestsSignatureRequestIdDocumentsDownload | GET /signature_requests/{signatureRequestId}/documents/download | Download Signature Request's Documents |
DocumentApi | patchSignatureRequestsSignatureRequestIdDocumentsDocumentId | PATCH /signature_requests/{signatureRequestId}/documents/{documentId} | Update a Document |
DocumentApi | postDocuments | POST /documents | [DEPRECATED] Upload a Document |
DocumentApi | postSignatureRequestsSignatureRequestIdDocuments | POST /signature_requests/{signatureRequestId}/documents | Add Document to a Signature Request |
DocumentApi | postSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplace | POST /signature_requests/{signatureRequestId}/documents/{documentId}/replace | Replace a Document in a Signature Request |
ElectronicSealApi | deleteElectronicSealImage | DELETE /electronic_seal_images/{electronicSealImageId} | Delete an Electronic Seal Image |
ElectronicSealApi | downloadElectronicSealAuditTrail | GET /electronic_seals/{electronicSealId}/audit_trails/download | Download an Electronic Seal Audit Trail |
ElectronicSealApi | downloadElectronicSealDocument | GET /electronic_seal_documents/{electronicSealDocumentId}/download | Download an Electronic Seal Document |
ElectronicSealApi | downloadElectronicSealImage | GET /electronic_seal_images/{electronicSealImageId}/download | Download an Electronic Seal Image |
ElectronicSealApi | getElectronicSeal | GET /electronic_seals/{electronicSealId} | Get an Electronic Seal |
ElectronicSealApi | getElectronicSealAuditTrail | GET /electronic_seals/{electronicSealId}/audit_trails | Get an Electronic Seal Audit Trail |
ElectronicSealApi | listElectronicSealImages | GET /electronic_seal_images | List Electronic Seal Images |
ElectronicSealApi | postElectronicSeals | POST /electronic_seals | Create an Electronic Seal |
ElectronicSealApi | uploadElectronicSealDocument | POST /electronic_seal_documents | Upload an Electronic Seal Document |
ElectronicSealApi | uploadElectronicSealImage | POST /electronic_seal_images | Upload an Electronic Seal Image |
FieldApi | deleteSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId | DELETE /signature_requests/{signatureRequestId}/documents/{documentId}/fields/{fieldId} | Delete a Field |
FieldApi | getSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields | GET /signature_requests/{signatureRequestId}/documents/{documentId}/fields | Lists the Fields of a Signature Request Document. |
FieldApi | postSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields | POST /signature_requests/{signatureRequestId}/documents/{documentId}/fields | Create a new Field on a Document |
FieldApi | updateSignatureRequestsSignatureRequestIdDocumentsDocumentIdFieldsFieldId | PATCH /signature_requests/{signatureRequestId}/documents/{documentId}/fields/{fieldId} | Update a Field |
FollowerApi | getSignatureRequestsSignatureRequestIdFollowers | GET /signature_requests/{signatureRequestId}/followers | List the Signature Request's Followers |
FollowerApi | postSignatureRequestsSignatureRequestIdFollowers | POST /signature_requests/{signatureRequestId}/followers | Create new Followers |
MetadataApi | deleteSignatureRequestsSignatureRequestIdMetadata | DELETE /signature_requests/{signatureRequestId}/metadata | Delete the Signature Request Metadata |
MetadataApi | getSignatureRequestsSignatureRequestIdMetadata | GET /signature_requests/{signatureRequestId}/metadata | Get the Signature Request Metadata |
MetadataApi | postSignatureRequestsSignatureRequestIdMetadata | POST /signature_requests/{signatureRequestId}/metadata | Attach Metadata to a Signature Request |
MetadataApi | putSignatureRequestsSignatureRequestIdMetadata | PUT /signature_requests/{signatureRequestId}/metadata | Update Metadata of a Signature Request |
SignatureRequestApi | deleteSignatureRequestsSignatureRequestId | DELETE /signature_requests/{signatureRequestId} | Delete a Signature Request |
SignatureRequestApi | getSignatureRequests | GET /signature_requests | List Signature Requests |
SignatureRequestApi | getSignatureRequestsSignatureRequestId | GET /signature_requests/{signatureRequestId} | Fetch a Signature Request |
SignatureRequestApi | patchSignatureRequestsSignatureRequestId | PATCH /signature_requests/{signatureRequestId} | Update a Signature Request |
SignatureRequestApi | postSignatureRequests | POST /signature_requests | Initiate a new Signature Request |
SignatureRequestApi | postSignatureRequestsSignatureRequestIdActivate | POST /signature_requests/{signatureRequestId}/activate | Activate a Signature Request |
SignatureRequestApi | postSignatureRequestsSignatureRequestIdCancel | POST /signature_requests/{signatureRequestId}/cancel | Cancel a Signature Request |
SignatureRequestApi | postSignatureRequestsSignatureRequestIdReactivate | POST /signature_requests/{signatureRequestId}/reactivate | Reactivate an expired Signature Request |
SignerApi | deleteSignatureRequestsSignatureRequestIdSignersSignerId | DELETE /signature_requests/{signatureRequestId}/signers/{signerId} | Delete a Signer |
SignerApi | getSignatureRequestsSignatureRequestIdSigners | GET /signature_requests/{signatureRequestId}/signers | List Signature Request's Signers |
SignerApi | getSignersSignersId | GET /signature_requests/{signatureRequestId}/signers/{signerId} | Get a Signer |
SignerApi | patchSignatureRequestsSignatureRequestIdSignersSignerId | PATCH /signature_requests/{signatureRequestId}/signers/{signerId} | Update a Signer |
SignerApi | postSignatureRequestsSignatureRequestIdSigners | POST /signature_requests/{signatureRequestId}/signers | Create a new Signer |
SignerApi | postSignatureRequestsSignatureRequestIdSignersSignerIdSendOtp | POST /signature_requests/{signatureRequestId}/signers/{signerId}/send_otp | Send a One-Time Password (OTP) to a Signer |
SignerApi | postSignatureRequestsSignatureRequestIdSignersSignerIdSendReminder | POST /signature_requests/{signatureRequestId}/signers/{signerId}/send_reminder | Send manual reminder to a Signer |
SignerApi | postSignatureRequestsSignatureRequestIdSignersSignerIdSign | POST /signature_requests/{signatureRequestId}/signers/{signerId}/sign | Sign a Signature Request |
SignerDocumentRequestApi | deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestId | DELETE /signature_requests/{signatureRequestId}/document_requests/{documentRequestId} | Delete a Signer Document Request |
SignerDocumentRequestApi | deleteSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId | DELETE /signature_requests/{signatureRequestId}/document_requests/{documentRequestId}/signers/{signerId} | Remove a Signer to a given Signer Document Request |
SignerDocumentRequestApi | deleteSignatureRequestsSignatureRequestIdSignersSignerIdDocuments | DELETE /signature_requests/{signatureRequestId}/signers/{signerId}/documents | Delete the Documents uploaded by a Signer |
SignerDocumentRequestApi | getSignatureRequestsSignatureRequestIdSignersSignerIdDocuments | GET /signature_requests/{signatureRequestId}/signers/{signerId}/documents | List the Signer Documents of a Signer |
SignerDocumentRequestApi | getSignatureRequestsSignatureRequestIdSignersSignerIdDocumentsSignerDocumentId | GET /signature_requests/{signatureRequestId}/signers/{signerId}/documents/{signerDocumentId}/download | Download a Signer Document |
SignerDocumentRequestApi | postSignatureRequestsSignatureRequestIdDocumentRequests | POST /signature_requests/{signatureRequestId}/document_requests | Add Signer Document Request to a Signature Request |
SignerDocumentRequestApi | putSignatureRequestsSignatureRequestIdDocumentRequestsDocumentRequestIdSignersSignerId | PUT /signature_requests/{signatureRequestId}/document_requests/{documentRequestId}/signers/{signerId} | Adds a Signer to a given Signer Document Request |
TemplateApi | getTemplates | GET /templates | List Templates |
UserApi | deleteWorkspaceWorkspaceIdUsersUserId | DELETE /workspaces/{workspaceId}/users/{userId} | Remove a user from a workspace |
UserApi | getUsers | GET /users | List Users |
UserApi | putWorkspacesWorkspaceIdUsers | PUT /workspaces/{workspaceId}/users/{userId} | Associate a user to a workspace |
WebhookApi | deleteWebhooksWebhookId | DELETE /webhooks/{webhookId} | Delete a Webhook subscription |
WebhookApi | getWebhooks | GET /webhooks | List Webhook subscriptions |
WebhookApi | getWebhooksWebhookId | GET /webhooks/{webhookId} | Get a Webhook subscription |
WebhookApi | patchWebhooksWebhookId | PATCH /webhooks/{webhookId} | Update a Webhook subscription |
WebhookApi | postWebhooksSubscriptions | POST /webhooks | Create a Webhook subscription |
WorkspaceApi | deleteWorkspace | DELETE /workspaces/{workspaceId} | Delete a Workspace |
WorkspaceApi | getWorkspaces | GET /workspaces | List Workspaces |
WorkspaceApi | getWorkspacesDefault | GET /workspaces/default | Get the default Workspace |
WorkspaceApi | getWorkspacesWorkspaceId | GET /workspaces/{workspaceId} | Get a Workspace |
WorkspaceApi | markWorkspaceAsDefault | POST /workspaces/default | Mark the given Workspace as default |
WorkspaceApi | patchWorkspacesWorkspaceId | PATCH /workspaces/{workspaceId} | Update a Workspace |
WorkspaceApi | postWorkspace | POST /workspaces | Create a Workspace |
Models
- Approver
- ApproverInfo
- ApproverToNotify
- ArchivedFile
- Archiving
- AuditTrailLocale
- Checkbox
- Checkbox1
- Checkbox2
- Consumption
- ConsumptionApi
- ConsumptionApp
- ConsumptionAppQualifiedElectronicSignatureIdentificationMode
- ConsumptionAppQualifiedElectronicSignatureIdentificationModeIdentityVerification
- Contact
- CreateContact
- CreateCustomExperience
- CreateCustomExperienceRedirectUrls
- CreateDocumentFromMultipart
- CreateElectronicSealFieldReadOnlyTextPayload
- CreateElectronicSealFieldSealPayload
- CreateElectronicSealPayload
- CreateElectronicSealPayloadFieldsInner
- CreateField
- CreateFieldFont
- CreateFollowersInner
- CreateSignatureRequest
- CreateSignatureRequestMetadata
- CreateSignatureRequestReminderSettings
- CreateSignatureRequestSignersInner
- CreateSignatureRequestTemplatePlaceholders
- CreateSignatureRequestTemplatePlaceholdersSignersInner
- CreateSigner
- CreateSignerDocumentRequest
- CreateWebhookSubscription
- CreateWebhookSubscriptionScopes
- CreateWebhookSubscriptionSubscribedEvents
- CreateWebhookSubscriptionWorkspaces
- CreateWorkspace
- CustomExperience
- CustomExperienceDisabledNotificationsType
- CustomExperienceRedirectUrls
- CustomExperienceSource
- Document
- DocumentInitials
- ElectronicSeal
- ElectronicSealAuditTrail
- ElectronicSealDocument
- ElectronicSealImage
- EmbeddedSignerWithSignatureLink
- FieldCheckbox
- FieldMention
- FieldRadioButtonGroup
- FieldRadioButtonGroupRadiosInner
- FieldReadOnlyText
- FieldSignature
- FieldText
- FieldType
- FieldsInput
- Follower
- Font
- FontFamily
- FontVariants
- FromExistingContact
- FromExistingContact1
- FromExistingSigner
- FromExistingUser
- FromExistingUser1
- FromScratch
- FromScratch1
- FromScratch1CustomText
- FromScratch1Info
- FromScratch1RedirectUrls
- FromScratchInfo
- GetContacts200Response
- GetCustomExperiences200Response
- GetSignatureRequests200Response
- GetSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields200Response
- GetSignatureRequestsSignatureRequestIdDocumentsDocumentIdFields200ResponseDataInner
- GetSignatureRequestsSignatureRequestIdFollowers200Response
- GetSignatureRequestsSignatureRequestIdSignersSignerIdDocuments200Response
- GetTemplates200Response
- GetUsers200Response
- GetWorkspaces200Response
- InitialsArea
- ListElectronicSealImages200Response
- Locale
- MarkWorkspaceAsDefault
- Mention
- Mention1
- Mention2
- Metadata
- MetadataDataValue
- OtpMessage
- Pagination
- PatchCustomExperienceLogoRequest
- PatchSignatureRequestsSignatureRequestIdApproversApproverIdRequest
- PatchSignatureRequestsSignatureRequestIdApproversApproverIdRequestInfo
- PostArchives401Response
- PostSignatureRequestsSignatureRequestIdApproversRequest
- PostSignatureRequestsSignatureRequestIdCancelRequest
- PostSignatureRequestsSignatureRequestIdDocumentsDocumentIdReplaceRequest
- PostSignatureRequestsSignatureRequestIdReactivateRequest
- RadioGroup
- RadioGroup1
- RadioGroup1RadiosInner
- RadioGroup2
- RadioGroup2RadiosInner
- RadioGroupRadiosInner
- ReadOnlyText
- ReadOnlyText1
- Signature
- Signature1
- Signature2
- SignatureRequest
- SignatureRequestActivated
- SignatureRequestActivatedDocumentsInner
- SignatureRequestDeclineInformation
- SignatureRequestEmailNotification
- SignatureRequestEmailNotificationSender
- SignatureRequestInList
- SignatureRequestInListApproversInner
- SignatureRequestInListDocumentsInner
- SignatureRequestInListReminderSettings
- SignatureRequestInListSender
- SignatureRequestInListSignersInner
- SignatureRequestPlaceholderReadOnlyTextFieldSubstituteInput
- SignatureRequestPlaceholderSignerSubstituteFromContactIdInput
- SignatureRequestPlaceholderSignerSubstituteFromInfoInput
- SignatureRequestPlaceholderSignerSubstituteFromInfoInputInfo
- SignatureRequestPlaceholderSignerSubstituteFromUserIdInput
- SignatureRequestSignerFromContactIdInput
- SignatureRequestSignerFromInfoInput
- SignatureRequestSignerFromInfoInputInfo
- SignatureRequestSignerFromInfoInputRedirectUrls
- SignatureRequestSignerFromUserIdInput
- SignatureRequestStatus
- Signer
- SignerAuditTrail
- SignerCustomText
- SignerDeliveryMode
- SignerDocument
- SignerDocumentRequest
- SignerFieldsInner
- SignerInfo
- SignerRedirectUrls
- SignerSIPAddress
- SignerSign
- SignerSignWithUploadedSignatureImage
- SmsNotification
- SmsNotification1
- Template
- Text
- Text1
- Text2
- UpdateContact
- UpdateCustomExperience
- UpdateCustomExperienceRedirectUrls
- UpdateDocument
- UpdateField
- UpdateFieldFont
- UpdateSignatureRequest
- UpdateSignatureRequestMetadata
- UpdateSignatureRequestMetadataDataValue
- UpdateSignatureRequestReminderSettings
- UpdateSigner
- UpdateSignerInfo
- UpdateWebhookSubscription
- UpdateWorkspace
- UploadArchivedFile
- UploadElectronicSealDocument
- UploadElectronicSealImage
- User
- UserWorkspacesInner
- ViolationResponse
- WebhookSubscription
- WebhookSubscriptionScopes
- WebhookSubscriptionSubscribedEvents
- WebhookSubscriptionWorkspaces
- Workspace
- WorkspaceUsersInner
Authorization
Authentication schemes defined for the API:
bearerAuth
- Type: Bearer authentication
Tests
To run the tests, use:
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
3.0
- Generator version:
7.8.0
- Generator version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen
All versions of yousign-api-v3 with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0