From 3d78023b0d95e682e6570b6b0beb0f24c0753d08 Mon Sep 17 00:00:00 2001 From: inbargazit Date: Mon, 22 Apr 2024 13:11:22 -0700 Subject: [PATCH] Branding updates --- LICENSE | 2 +- README.md | 40 +++++++++--------- azure-pipelines.yml | 11 +++++ public/assets/favicon.ico | Bin 33310 -> 0 bytes public/assets/favicon.png | Bin 0 -> 1221 bytes .../SetDocumentsVisibilityService.php | 2 +- templates/base.html | 4 +- .../esignature/quickEmbeddedSigning.html | 4 +- 8 files changed, 37 insertions(+), 26 deletions(-) delete mode 100644 public/assets/favicon.ico create mode 100644 public/assets/favicon.png diff --git a/LICENSE b/LICENSE index 5ea8153..42c1602 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License -Copyright (c) 2018 DocuSign, Inc. (https://www.docusign.com) +Copyright (c) 2024 Docusign, Inc. (https://www.docusign.com) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 83864e5..3a6f06f 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,22 @@ ### GitHub repo: [code-examples-php](./README.md) -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`. +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`. -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. +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. ## Introduction This repo is a PHP application that supports the following authentication workflows: -* Authentication with DocuSign via [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode). +* Authentication with Docusign via [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode). When the token expires, the user is asked to re-authenticate. The refresh token is not used. -* Authentication with DocuSign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/). +* Authentication with Docusign via [JSON Web Token (JWT) Grant](https://developers.docusign.com/platform/auth/jwt/). When the token expires, it updates automatically. -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. +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. The OAuth library is used in the file [index.php](./public/index.php). @@ -25,58 +25,58 @@ The OAuth library is used in the file [index.php](./public/index.php). 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). -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. +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. ## Rooms API -**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. +**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. 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/). -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. +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. ## Click API 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) -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. +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. ## Monitor API -**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/). +**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/). 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/). -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. +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. ## Admin API -**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). +**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). 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/). -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. +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. ## Web Forms API -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. +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. 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/). -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. +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. ## Installation ### Prerequisites -**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. +**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. -1. A free [DocuSign developer account](https://go.docusign.com/o/sandbox/); create one if you don't already have one. -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. +1. A free [Docusign developer account](https://go.docusign.com/o/sandbox/); create one if you don't already have one. +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. This [video](https://www.youtube.com/watch?v=eiRI4fe5HgM) demonstrates how to obtain an integration key. @@ -104,7 +104,7 @@ For a list of code examples that use the Web Forms API, see the [How-to guides o ### Installation steps -**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. +**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. 1. Extract the Quickstart ZIP file or download or clone the code-examples-php repository. 1. In your command-line environment, switch to the folder: `cd ` or `cd code-examples-php` @@ -196,7 +196,7 @@ Apache will run. ## JWT grant remote signing and Authorization Code Grant embedded signing projects -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. +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. ## Payments code example diff --git a/azure-pipelines.yml b/azure-pipelines.yml index ed94f68..a5aee1e 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -87,6 +87,17 @@ steps: - script: dir $(Build.SourcesDirectory)/code-examples-php-private +- script: | + echo "Checking for running Docker containers..." + containers=$(docker ps -q) + if [ ! -z "$containers" ]; then + echo "Stopping running Docker containers..." + docker stop $(docker ps -q) + else + echo "No Docker containers are running." + fi + displayName: "check for running containers" + - script: | echo "kill and remove any running containers" docker rm -f $(docker ps -a -q) diff --git a/public/assets/favicon.ico b/public/assets/favicon.ico deleted file mode 100644 index fd990b6942f717e57af521d6c65eb20998282e55..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 33310 zcmeHQYit}>6+V9L%Wu0*9p_<_rYKYbwSQ1)DWoY0h(AdDKte)LXcN-LiIX^v^YW`n zleAT#gc1-czbJve5L8uD8mhXKN+3kjl(s2(l!t`GPnyJDdv|8d`F8j0%+6zXc6WAn zX1gmLoq61Q&i9>r=H5GZW^AGcYN4(!Vm(Cbnu)$fME(8g{V>ra9~&A3v18d{N{!GXeUNL`6ZAvTP4Gd38@#XMX-V7|bNIvZ})+GN9LQrkFp>G$^WxO9f= zuT0R!+g1AT&6J&nh6G*VZ5#uS%Q@;JZvUE1mB%*fHa4dG!NxydwfAk+22G7BL9EU> zIo8t5^_z;X9||f28%}&xsSNrF?rMm;lVtzHiirCh)2~YST#w!O7L_(}E`H&5h3>jd zlMT1VIpK&w^v7Q& zSeEGZQwjP5%WJ1pLO(nEq(ZOS2+pAl1ohr|p|I;!u*{v)`T#lRmcDv6L0|s7l5BtU zQEu6VohxknOLu7fCh`RRmK#1`XVV?#ws*q^Y=6cV~94dKv~pr+8#%CX|@{K&X1-Pn%I^a*MNI!IFUStbHW34oZ3(3 z%jXmxP0o!)*M)}?@l_H@8 zg+ppef~<8C;%&VI0}4U($FQxhliW_*gKhYLFCz|cKwas}%cbE1zP#oiF~k>9rLq_%biU;}tyCN)?$>yWZ_(w(kjuAVIIy)mZQ;bX zU^sZ6yYrYrd<%v{+)i#>2l_l0+vvk&TXbKKdF%l0QZQg{DE39K>{sdB^RcYs4aE2E zFDkTZxf#RZk>W8-Z_oA*`&e%PC&2^Vm|n9xe_AzRD0NOdHJrjQIH1z|FKOc@)*1za ze$5XUR;S}|z@@(Nha;!Rq>tgtR^Yv9Q8e&SPy6%|BvMPG45Gd%G4h_s#9C zzj9AO`_9(xL5Vbvzx>h#f3qIi+7=Q(sfGuDC z9pkz(fAN|IuYC9s6R+VGJiwL@KXO6Jdri+UwtV>g9)IMR*WxaCoaF!6-^Te_-U6MN zh|yyQ8o`875a}tCE4G>2FpWi6SkASxbFdm zzdTp@`=NaKT0dXD@%TTlD|G&)%HIRI(WaMQQTQ2roY!p>diO zmdtxXIAHwwjF)f5ntEL8eMUV8{G9_>f5G=y(YNuYBU?Ee^d=ax=B-_e#5Z09TA%{FcQF&4qq%lHH@u!94*fRocWAeKFy=Cv+aGxD1Tmut+) zDSzY|;_Ww{c6h<%3UhMGAJ-!C(axUVj)M#O7^nPEw$}KgO`Y;bu5@+OPWvPOaZNkr zkG`V2#`-_>=}!6MyX@O;xyJ8m&C}qD1%B6Tfd-bvXn9|puJ6UTxRe%*k9xs)qe*YK zjGLO4ajI0UALnGegVy|~a4qXq>60H{C}{k18YlTqT{Pw!dXagEUZWk{5dAzyZ(sZi zCZ}BL<@`NYueYE7+VA9al*YHrai8I>=iHUZr3ZJ<^ZOX7_eA#GGf#^id)8mh7|iU5 zX1;}$x%4Pv@Da#^iEYfCpF0U}y{`2<0CzoKtL-t)1B~6}%)e^bPPV)5@Az49mt%YH zt*sawx<7xr3wP0oK`rzL#cO*7&EWL zV2b|^gx!4Ji1{mb*?)r~Wxu*WTHfCW?C|s>{v+i3Ilto>ua{6Q7|M+Beav)#7w@b%e@<)%|xNZCv z$4LyT-3Lq#TlasX_oQ-Oc#F3BhDzcPXfZ#d!nLsb+tzvDmHTAlde+{}*4z;T{J$9C zYt&Z!Q3o*?{Z4iaymo*5(AYdRHznxceYyK0d@pC@E&I8?#lf{Oc5kZB#h8nI$tkbs zv%kszE;+7o;cL{vK>lw5{`72h`Z~8_j2t)emi-Wa-{h7bui61e;cL|RzRRn)-NJ?M zrHs5~KOD+`{kVmrT6S8)_H*C}pQ{$GO8IST%^t_3?V%ByO5v!MpN=+r{`kJITDU6Z zx2xU$-mWd;@3GBE47)q+`M2}6;lzfY%k*~H^T)N}XKqfg_w~%#j(;Bo{>ysp`FC>P z;3S5AE^~dKJ^${G+ULKr-=06N4L`T76YMvwy~1k%isd@Ms^zuc{!U_4FXO*=`RZ*} RZ?k$1)N`Po1HQ_E{{uWiH2VMm diff --git a/public/assets/favicon.png b/public/assets/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..fefff5520d83a3686f8d1a411a24582bf40717b0 GIT binary patch literal 1221 zcmV;$1UmbPP)*vk@IiGJN#SJqlwialH6qg2vEMmTZGeX}RZT&bcjZ z`O^~8uqNM}d;919KIi-UopXK#4tep_tKi$W!NbGgOy*@Knqny@m}s(rK4K{yw(S8X z>f&rR#8XpX#{o+TCIU}Rg41cRZ66jM`iqwNGEtO?X4!F=9mgw;^+i+}iS8;Xud!`M z41jGzX_!Eu0f3a2`GJ%jOf;__sE7)RNO2uif36%yu`gDRb6-jM7Q61Q6H3Yk4(tJ7 zqT&%9@B>$%c1rI*X4@W8+SwzeKpqpIR>lD)(&^JMYfN;(JR3L>0G&EN4HYM5Scrgr zK0X9PfUPmGC8~7uwV41K0To)p@E=0bpyb$>ZV`KRzsZ^d_*VyY-0_=wGF$lMaT-?tGXttS4a7LP-O?w>9frMsDU^g2$*zCoHmAAko>myqQi{04h77S30IA z%wg1I04@WJ#$tDC04lRDvXnU{YBguUi2?Xc%D=`1qHCPVn4SP91fZAXQxjauId+^g z+Ww=aV50@E-qE|Dg-{U)c=Z%S&@9E#Sl7~KI=!aPh^kd^i-|f-OEx|Z-5oUqxPr9@ zr_u3SqnTH2$!3hlqAQ!}R8c$N5&gwPpDEXknjRw__nT9yn*wF-1&Z5mV&;!lymO}= z!%I;N)l~tOU4EfZuJR j-cEwUNw9XfZVLVf6}&j39e`aL00000NkvXXu0mjfO4u@9 literal 0 HcmV?d00001 diff --git a/src/Services/Examples/eSignature/SetDocumentsVisibilityService.php b/src/Services/Examples/eSignature/SetDocumentsVisibilityService.php index 953e348..c5eb977 100644 --- a/src/Services/Examples/eSignature/SetDocumentsVisibilityService.php +++ b/src/Services/Examples/eSignature/SetDocumentsVisibilityService.php @@ -17,7 +17,7 @@ class SetDocumentsVisibilityService const CASE_FOR_INSTRUCTIONS = "ACCOUNT_LACKS_PERMISSIONS"; const FIXING_INSTRUCTIONS_FOR_PERMISSIONS = "See " . "" . - "How to set document visibility for envelope recipients in the DocuSign Developer Center " . + "How to set document visibility for envelope recipients in the Docusign Developer Center " . "for instructions on how to enable document visibility in your developer account."; public static function worker( diff --git a/templates/base.html b/templates/base.html index 3947db2..c185378 100644 --- a/templates/base.html +++ b/templates/base.html @@ -5,7 +5,7 @@ - + {{ title }} @@ -16,7 +16,7 @@