Skip to content

Commit 3d78023

Browse files
committed
Branding updates
1 parent 9bb01f2 commit 3d78023

File tree

8 files changed

+37
-26
lines changed

8 files changed

+37
-26
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License
22

3-
Copyright (c) 2018 DocuSign, Inc. (https://www.docusign.com)
3+
Copyright (c) 2024 Docusign, Inc. (https://www.docusign.com)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,81 +2,81 @@
22

33
### GitHub repo: [code-examples-php](./README.md)
44

5-
This GitHub repo includes code examples for the DocuSign Admin API, Click API, eSignature REST API, Monitor API, and Rooms API. To switch between API code examples, modify the `EXAMPLES_API_TYPE` setting in the ds_config.php file. Set only one API type to `true` and set the remaining to `false`.
5+
This GitHub repo includes code examples for the Docusign Admin API, Click API, eSignature REST API, Monitor API, and Rooms API. To switch between API code examples, modify the `EXAMPLES_API_TYPE` setting in the ds_config.php file. Set only one API type to `true` and set the remaining to `false`.
66

7-
If none of the API types are set to `true`, the DocuSign eSignature REST API code examples will be shown. If multiple API types are set to `true`, only the first will be shown.
7+
If none of the API types are set to `true`, the Docusign eSignature REST API code examples will be shown. If multiple API types are set to `true`, only the first will be shown.
88

99

1010
## Introduction
1111
This repo is a PHP application that supports the following authentication workflows:
1212

13-
* Authentication with DocuSign via [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode).
13+
* Authentication with Docusign via [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode).
1414
When the token expires, the user is asked to re-authenticate. The refresh token is not used.
1515

16-
* Authentication with DocuSign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/).
16+
* Authentication with Docusign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/).
1717
When the token expires, it updates automatically.
1818

1919

20-
The [PHP OAuth 2.0 Client package](http://oauth2-client.thephpleague.com/) is used for authentication. This launcher includes a DocuSign OAuth2 [provider](src/Controllers/Auth/DocuSign.php) for the OAuth package and a [resource owner](src/Controllers/Auth/DocuSignResourceOwner.php) to process the results of the call to OAuth::getUser.
20+
The [PHP OAuth 2.0 Client package](http://oauth2-client.thephpleague.com/) is used for authentication. This launcher includes a Docusign OAuth2 [provider](src/Controllers/Auth/Docusign.php) for the OAuth package and a [resource owner](src/Controllers/Auth/DocusignResourceOwner.php) to process the results of the call to OAuth::getUser.
2121

2222
The OAuth library is used in the file [index.php](./public/index.php).
2323

2424
## eSignature API
2525

2626
For more information about the scopes used for obtaining authorization to use the eSignature API, see [Required scopes](https://developers.docusign.com/docs/esign-rest-api/esign101/auth#required-scopes).
2727

28-
For a list of code examples that use the eSignature API, see the [How-to guides overview](https://developers.docusign.com/docs/esign-rest-api/how-to/) on the DocuSign Developer Center.
28+
For a list of code examples that use the eSignature API, see the [How-to guides overview](https://developers.docusign.com/docs/esign-rest-api/how-to/) on the Docusign Developer Center.
2929

3030

3131
## Rooms API
3232

33-
**Note:** To use the Rooms API, you must also [create your Rooms developer account](https://developers.docusign.com/docs/rooms-api/rooms101/create-account). Examples 4 and 6 require that you have the DocuSign Forms feature enabled in your Rooms for Real Estate account.
33+
**Note:** To use the Rooms API, you must also [create your Rooms developer account](https://developers.docusign.com/docs/rooms-api/rooms101/create-account). Examples 4 and 6 require that you have the Docusign Forms feature enabled in your Rooms for Real Estate account.
3434
For more information about the scopes used for obtaining authorization to use the Rooms API, see [Required scopes](https://developers.docusign.com/docs/rooms-api/rooms101/auth/).
3535

36-
For a list of code examples that use the Rooms API, see the [How-to guides overview](https://developers.docusign.com/docs/rooms-api/how-to/) on the DocuSign Developer Center.
36+
For a list of code examples that use the Rooms API, see the [How-to guides overview](https://developers.docusign.com/docs/rooms-api/how-to/) on the Docusign Developer Center.
3737

3838

3939
## Click API
4040
For more information about the scopes used for obtaining authorization to use the Click API, see [Required scopes](https://developers.docusign.com/docs/click-api/click101/auth/#required-scopes)
4141

42-
For a list of code examples that use the Click API, see the [How-to guides overview](https://developers.docusign.com/docs/click-api/how-to/) on the DocuSign Developer Center.
42+
For a list of code examples that use the Click API, see the [How-to guides overview](https://developers.docusign.com/docs/click-api/how-to/) on the Docusign Developer Center.
4343

4444

4545
## Monitor API
4646

47-
**Note:** To use the Monitor API, you must also [enable DocuSign Monitor for your organization](https://developers.docusign.com/docs/monitor-api/how-to/enable-monitor/).
47+
**Note:** To use the Monitor API, you must also [enable Docusign Monitor for your organization](https://developers.docusign.com/docs/monitor-api/how-to/enable-monitor/).
4848

4949
For information about the scopes used for obtaining authorization to use the Monitor API, see the [scopes section](https://developers.docusign.com/docs/monitor-api/monitor101/auth/).
5050

51-
For a list of code examples that use the Monitor API, see the [How-to guides overview](https://developers.docusign.com/docs/monitor-api/how-to/) on the DocuSign Developer Center.
51+
For a list of code examples that use the Monitor API, see the [How-to guides overview](https://developers.docusign.com/docs/monitor-api/how-to/) on the Docusign Developer Center.
5252

5353

5454
## Admin API
5555

56-
**Note:** To use the Admin API, you must [create an organization](https://support.docusign.com/en/guides/org-admin-guide-create-org) in your DocuSign developer account. Also, to run the DocuSign CLM code example, [CLM must be enabled for your organization](https://support.docusign.com/en/articles/DocuSign-and-SpringCM).
56+
**Note:** To use the Admin API, you must [create an organization](https://support.docusign.com/en/guides/org-admin-guide-create-org) in your Docusign developer account. Also, to run the Docusign CLM code example, [CLM must be enabled for your organization](https://support.docusign.com/en/articles/Docusign-and-SpringCM).
5757

5858
For information about the scopes used for obtaining authorization to use the Admin API, see the [scopes section](https://developers.docusign.com/docs/admin-api/admin101/auth/).
5959

60-
For a list of code examples that use the Admin API, see the [How-to guides overview](https://developers.docusign.com/docs/admin-api/how-to/) on the DocuSign Developer Center.
60+
For a list of code examples that use the Admin API, see the [How-to guides overview](https://developers.docusign.com/docs/admin-api/how-to/) on the Docusign Developer Center.
6161

6262

6363
## Web Forms API
6464

65-
The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact [DocuSign Support](https://support.docusign.com/) or your account manager to find out whether the Web Forms API is available for your production account plan.
65+
The Web Forms API is available in all developer accounts, but only in certain production account plans. Contact [Docusign Support](https://support.docusign.com/) or your account manager to find out whether the Web Forms API is available for your production account plan.
6666

6767
For more information about the scopes used for obtaining authorization to use the Rooms API, see [Required scopes](https://developers.docusign.com/docs/web-forms-api/plan-integration/authentication/).
6868

69-
For a list of code examples that use the Web Forms API, see the [How-to guides overview](https://developers.docusign.com/docs/web-forms-api/how-to/) on the DocuSign Developer Center.
69+
For a list of code examples that use the Web Forms API, see the [How-to guides overview](https://developers.docusign.com/docs/web-forms-api/how-to/) on the Docusign Developer Center.
7070

7171

7272
## Installation
7373

7474
### Prerequisites
7575

76-
**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart) from the DocuSign Developer Center, skip items 1 and 2 below as they were automatically performed for you.
76+
**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart) from the Docusign Developer Center, skip items 1 and 2 below as they were automatically performed for you.
7777

78-
1. A free [DocuSign developer account](https://go.docusign.com/o/sandbox/); create one if you don't already have one.
79-
1. A DocuSign app and integration key that is configured to use either [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) or [JWT Grant](https://developers.docusign.com/platform/auth/jwt/) authentication.
78+
1. A free [Docusign developer account](https://go.docusign.com/o/sandbox/); create one if you don't already have one.
79+
1. A Docusign app and integration key that is configured to use either [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/) or [JWT Grant](https://developers.docusign.com/platform/auth/jwt/) authentication.
8080

8181
This [video](https://www.youtube.com/watch?v=eiRI4fe5HgM) demonstrates how to obtain an integration key.
8282

@@ -104,7 +104,7 @@ For a list of code examples that use the Web Forms API, see the [How-to guides o
104104

105105
### Installation steps
106106

107-
**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart) from the DocuSign Developer Center, skip step 4 below as it was automatically performed for you.
107+
**Note:** If you downloaded this code using [Quickstart](https://developers.docusign.com/docs/esign-rest-api/quickstart) from the Docusign Developer Center, skip step 4 below as it was automatically performed for you.
108108

109109
1. Extract the Quickstart ZIP file or download or clone the code-examples-php repository.
110110
1. In your command-line environment, switch to the folder: `cd <Quickstart_folder>` or `cd code-examples-php`
@@ -196,7 +196,7 @@ Apache will run.
196196

197197

198198
## JWT grant remote signing and Authorization Code Grant embedded signing projects
199-
See [DocuSign Quickstart overview](https://developers.docusign.com/docs/esign-rest-api/quickstart/overview/) on the DocuSign Developer Center for more information on how to run the JWT grant remote signing and the Authorization Code Grant embedded signing project.
199+
See [Docusign Quickstart overview](https://developers.docusign.com/docs/esign-rest-api/quickstart/overview/) on the Docusign Developer Center for more information on how to run the JWT grant remote signing and the Authorization Code Grant embedded signing project.
200200

201201

202202
## Payments code example

azure-pipelines.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,17 @@ steps:
8787

8888
- script: dir $(Build.SourcesDirectory)/code-examples-php-private
8989

90+
- script: |
91+
echo "Checking for running Docker containers..."
92+
containers=$(docker ps -q)
93+
if [ ! -z "$containers" ]; then
94+
echo "Stopping running Docker containers..."
95+
docker stop $(docker ps -q)
96+
else
97+
echo "No Docker containers are running."
98+
fi
99+
displayName: "check for running containers"
100+
90101
- script: |
91102
echo "kill and remove any running containers"
92103
docker rm -f $(docker ps -a -q)

public/assets/favicon.ico

-32.5 KB
Binary file not shown.

public/assets/favicon.png

1.19 KB
Loading

src/Services/Examples/eSignature/SetDocumentsVisibilityService.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class SetDocumentsVisibilityService
1717
const CASE_FOR_INSTRUCTIONS = "ACCOUNT_LACKS_PERMISSIONS";
1818
const FIXING_INSTRUCTIONS_FOR_PERMISSIONS = "See " .
1919
"<a href=\"https://developers.docusign.com/docs/esign-rest-api/how-to/set-document-visibility\">" .
20-
"How to set document visibility for envelope recipients</a> in the DocuSign Developer Center " .
20+
"How to set document visibility for envelope recipients</a> in the Docusign Developer Center " .
2121
"for instructions on how to enable document visibility in your developer account.";
2222

2323
public static function worker(

templates/base.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
66
<meta name="description" content="">
77
<meta name="author" content="">
8-
<link rel="icon" href="{{ app_url ~ 'assets/favicon.ico' }}">
8+
<link rel="icon" href="{{ app_url ~ 'assets/favicon.png' }}">
99
<title>{{ title }}</title>
1010
<!-- Bootstrap core CSS -->
1111
<script src="https://kit.fontawesome.com/a2fb399780.js" crossorigin="anonymous"></script>
@@ -16,7 +16,7 @@
1616

1717
<body>
1818
<nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
19-
<a class="navbar-brand" href="https://developers.docusign.com/">DocuSign Developer</a>
19+
<a class="navbar-brand" href="https://developers.docusign.com/">Docusign Developer</a>
2020
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsExampleDefault" aria-controls="navbarsExampleDefault" aria-expanded="false" aria-label="Toggle navigation">
2121
<span class="navbar-toggler-icon"></span>
2222
</button>

templates/esignature/quickEmbeddedSigning.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
66
<meta name="description" content="">
77
<meta name="author" content="">
8-
<link rel="icon" href="{{ app_url ~ 'assets/favicon.ico' }}">
8+
<link rel="icon" href="{{ app_url ~ 'assets/favicon.png' }}">
99
<title>{{ title }}</title>
1010
<!-- Bootstrap core CSS -->
1111
<link href="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh" crossorigin="anonymous">
@@ -16,7 +16,7 @@
1616
<body>
1717

1818
<nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
19-
<a class="navbar-brand" target="_blank" href="https://developers.docusign.com">DocuSign Developer</a>
19+
<a class="navbar-brand" target="_blank" href="https://developers.docusign.com">Docusign Developer</a>
2020
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsExampleDefault" aria-controls="navbarsExampleDefault" aria-expanded="false" aria-label="Toggle navigation">
2121
<span class="navbar-toggler-icon"></span>
2222
</button>

0 commit comments

Comments
 (0)