Skip to content

Updating for October GA Release #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
InbarGazit merged 1 commit into from
Oct 18, 2019
Merged

Updating for October GA Release #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 23 additions & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,50 +11,50 @@ This repo is a PHP 7.2 application that demonstrates:

The [PHP OAuth 2.0 Client package](http://oauth2-client.thephpleague.com/) is used
for authentication. This example includes a DocuSign OAuth2
[provider](./src/DocuSign.php)
for the OAuth package, and a [resource owner](./src/DocuSignResourceOwner.php) used to process the OAuth::getUser results.
[provider](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/DocuSign.php)
for the OAuth package, and a [resource owner](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/DocuSignResourceOwner.php) used to process the OAuth::getUser results.

The OAuth library is used by the example in file
[index.php](./public/index.php).
[index.php](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/public/index.php).

1. **Embedded Signing Ceremony.**
[Source.](./src/EG001EmbeddedSigning.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG001EmbeddedSigning.php)
This example sends an envelope, and then uses an embedded signing ceremony for the first signer.
With embedded signing, the DocuSign signing ceremony is initiated from your website.
1. **Send an envelope with a remote (email) signer and cc recipient.**
[Source.](./src/EG002SigningViaEmail.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG002SigningViaEmail.php)
The envelope includes a pdf, Word, and HTML document.
Anchor text ([AutoPlace](https://support.docusign.com/en/guides/AutoPlace-New-DocuSign-Experience)) is used to position the signing fields in the documents.
1. **List envelopes in the user's account.**
[Source.](./src/EG003ListEnvelopes.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG003ListEnvelopes.php)
The envelopes' current status is included.
1. **Get an envelope's basic information.**
[Source.](./src/EG004EnvelopeInfo.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG004EnvelopeInfo.php)
The example lists the basic information about an envelope, including its overall status.
1. **List an envelope's recipients**
[Source.](./src/EG005EnvelopeRecipients.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG005EnvelopeRecipients.php)
Includes current recipient status.
1. **List an envelope's documents.**
[Source.](./src/EG006EnvelopeDocs.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG006EnvelopeDocs.php)
1. **Download an envelope's documents.**
[Source.](./src/EG007EnvelopeGetDoc.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG007EnvelopeGetDoc.php)
The example can download individual
documents, the documents concatenated together, or a zip file of the documents.
1. **Programmatically create a template.**
[Source.](./src/EG008CreateTemplate.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG008CreateTemplate.php)
1. **Send an envelope using a template.**
[Source.](./src/EG009UseTemplate.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG009UseTemplate.php)
1. **Send an envelope and upload its documents with multpart binary transfer.**
[Source.](./src/EG010SendBinaryDocs.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG010SendBinaryDocs.php)
Binary transfer is 33% more efficient than using Base64 encoding.
1. **Embedded sending.**
[Source.](./src/EG011EmbeddedSending.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG011EmbeddedSending.php)
Embeds the DocuSign web tool (NDSE) in your web app to finalize or update
the envelope and documents before they are sent.
1. **Embedded DocuSign web tool (NDSE).**
[Source.](./src/EG012EmbeddedConsole.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG012EmbeddedConsole.php)
1. **Embedded Signing Ceremony from a template with an added document.**
[Source.](./src/EG013AddDocToTemplate.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG013AddDocToTemplate.php)
This example sends an envelope based on a template.
In addition to the template's document(s), the example adds an
additional document to the envelope by using the
Expand All @@ -63,34 +63,23 @@ This repo is a PHP 7.2 application that demonstrates:
1. Future: Payments example: an order form, with online payment by credit card.

Note: for PHP, this example is still in production.
[Source.](./src/EG014CollectPayment.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG014CollectPayment.php)
1. **Get the envelope tab data.**
Retrieve the tab (field) values for all of the envelope's recipients.
[Source.](./src/EG015EnvelopeTabData.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG015EnvelopeTabData.php)
1. **Set envelope tab values.**
The example creates an envelope and sets the initial values for its tabs (fields). Some of the tabs
are set to be read-only, others can be updated by the recipient. The example also stores
metadata with the envelope.
[Source.](./src/EG016SetTabValues.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG016SetTabValues.php)
1. **Set template tab values.**
The example creates an envelope using a template and sets the initial values for its tabs (fields).
The example also stores metadata with the envelope.
[Source.](./src/EG017SetTemplateTabValues.php)
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG017SetTemplateTabValues.php)
1. **Get the envelope custom field data (metadata).**
The example retrieves the custom metadata (custom data fields) stored with the envelope.
[Source.](./src/EG018EnvelopeCustomFieldData.php)
1. **Requiring an Access Code for a Recipient**
[Source.](./src/EG019AccessCodeAuthentication.php)
This example sends and envelope that requires an access-code for the purpose of multi-factor authentication.
1. **Requiring SMS authentication for a recipient**
[Source.](./src/EG020SmsAuthentication.php)
This example sends and envelope that requires entering in a six digit code from an text message for the purpose of multi-factor authentication.
1. **Requiring Phone authentication for a recipient**
[Source.](./src/EG021PhoneAuthentication.php)
This example sends and envelope that requires entering in a voice-based response code for the purpose of multi-factor authentication.
1. **Requiring Knowledge-Based Authentication (KBA) for a Recipient**
[Source.](./src/EG022KbAuthentication.php)
This example sends and envelope that requires passing a Public records check to validate identity for the purpose of multi-factor authentication.
[Source.](https://github.com/docusign/eg-03-php-auth-code-grant/blob/master/src/EG018EnvelopeCustomFieldData.php)


## Installation

Expand Down Expand Up @@ -149,7 +138,7 @@ To use the payments example, create a
test payments gateway for your developer sandbox account.

See the
[PAYMENTS_INSTALLATION.md](.ter/PAYMENTS_INSTALLATION.md)
[PAYMENTS_INSTALLATION.md](https://github.com/docusign/eg-03-python-auth-code-grant/blob/master/PAYMENTS_INSTALLATION.md)
file for instructions.

Then add the payment gateway account id to the **app/ds_config.php** file.
Expand Down
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
}
},
"require": {
"docusign/esign-client": "^3.0",
"docusign/esign-client": "4.0.0",
"twig/twig": "^2.0",
"league/oauth2-client": "^2.4",
"ext-json": "*",
Expand Down
Loading