Merge pull request #75 from hellosign/SDK-Audit

PHP SDK Audit

Author: jyoung488

.gitignore

@@ -12,3 +12,4 @@ phpunit_test_template_file.pdf
 test.php
 .idea
 *.swp
+vendor

CONTRIBUTING.md

@@ -6,7 +6,7 @@ We're excited you're considering contributing to our project! Your patches are e
 
 * Make sure you have a [GitHub account](https://github.com/signup/free)
 * Make sure you have a [HelloSign account](http://www.hellosign.com)
-* Submit a new [issue ticket](https://github.com/HelloFax/hellosign-php-sdk/issues), assuming one does not already exist.
+* Submit a new [issue ticket](https://github.com/hellosign/hellosign-php-sdk/issues), assuming one does not already exist.
   * Clearly describe the issue including steps to reproduce when it is a bug.
   * Make sure to include the version you are using which has the issue (and confirm that the issue you are having has not been fixed in a later version)
 * Fork the repository on GitHub

README.md

@@ -1,6 +1,6 @@
 ## HelloSign PHP SDK
 
-This is the official PHP SDK for HelloSign's API.  [View api documentation and examples.](https://app.hellosign.com/api/documentation)
+This is the official PHP SDK for HelloSign's API.  [View API Documentation and Examples.](https://app.hellosign.com/api/documentation)
 
 ## Installation
 
@@ -9,17 +9,17 @@ This is the official PHP SDK for HelloSign's API.  [View api documentation and e
 The latest version of the SDK requires PHP version 5.5 or higher.
 
 You can import this SDK into your library two ways, either through including the base HelloSign.php file into your
-project or using Composer ([https://getcomposer.org/doc/00-intro.md](https://getcomposer.org/doc/00-intro.md)).
+project or using [Composer](https://getcomposer.org/doc/00-intro.md).
 
-To use composer:
+To use Composer:
 
 - First, install Composer if you don't have it already
 
     ```shell
     curl -sS https://getcomposer.org/installer | php
     ```
 
-- Create `composer.json` and add the following
+- Create a `composer.json` file and add the following:
 
     ```json
     {
@@ -53,22 +53,19 @@ $client = new HelloSign\Client($apikey);
 
 ### Email/Password Config
 
-
 ```php
 $client = new HelloSign\Client($email_address, $password);
 ```
 
 ### Oauth Config
 
-
 ```php
 $client = new HelloSign\Client($oauth_token); //instance of HelloSign\OAuthToken
 ```
 
 Your app users are almost ready to start signing!
 See below for the most common use cases for this wrapper.
 
-
 ## Usage
 
 You can test your authentication by calling
@@ -147,6 +144,7 @@ if ($response->isComplete()) {
 ```
 
 ### Creating an Embedded Signature Request to use for Embedded Signing
+Refer to the (Embedded Signing Walkthrough)[https://app.hellosign.com/api/embeddedSigningWalkthrough] for more details.
 
 ```php
 // Create the SignatureRequest or TemplateSignatureRequest object

library/HelloSign/AbstractList.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * HelloSign PHP SDK (https://github.com/HelloFax/hellosign-php-sdk/)
+ * HelloSign PHP SDK (https://github.com/hellosign/hellosign-php-sdk/)
  */
 
 /**

library/HelloSign/AbstractObject.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * HelloSign PHP SDK (https://github.com/HelloFax/hellosign-php-sdk/)
+ * HelloSign PHP SDK (https://github.com/hellosign/hellosign-php-sdk/)
  */
 
 /**

library/HelloSign/AbstractResource.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * HelloSign PHP SDK (https://github.com/HelloFax/hellosign-php-sdk/)
+ * HelloSign PHP SDK (https://github.com/hellosign/hellosign-php-sdk/)
  */
 
 /**
@@ -56,7 +56,7 @@ abstract class AbstractResource extends AbstractObject
      * @var boolean
      */
     protected $test_mode = false;
-    
+
      /**
      * Whether the sender will allow the signer to decline to sign
      *
@@ -141,7 +141,7 @@ public function disableTestMode()
         $this->test_mode = false;
         return $this;
     }
-    
+
     /**
      * @return SignatureRequest
      * @ignore

library/HelloSign/AbstractResourceList.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * HelloSign PHP SDK (https://github.com/HelloFax/hellosign-php-sdk/)
+ * HelloSign PHP SDK (https://github.com/hellosign/hellosign-php-sdk/)
  */
 
 /**

library/HelloSign/AbstractSignatureRequest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * HelloSign PHP SDK (https://github.com/HelloFax/hellosign-php-sdk/)
+ * HelloSign PHP SDK (https://github.com/hellosign/hellosign-php-sdk/)
  */
 
 /**
@@ -85,6 +85,13 @@ abstract class AbstractSignatureRequest extends AbstractResource
      */
     protected $client_id = null;
 
+    /**
+     * A JSON array of Custom Field objects
+     *
+     * @var string
+     */
+    protected $custom_fields = null;
+
     /**
      * Constructor
      *
@@ -215,6 +222,32 @@ public function setHideTextTags($hide_text_tags)
         return $this;
     }
 
+    /**
+     * Set the value for a custom field with the given field name
+     * and optionally define a Role allowed to edit it and if the field is required to be filled
+     *
+     * @param  string $field_name field name to be filled in
+     * @param  string $value
+     * @param  string $editor
+     * @param  string $required
+     * @return AbstractSignatureRequest
+     */
+    public function setCustomFieldValue($field_name, $value, $editor = null, $required = null)
+    {
+        $custom_fields = isset($this->custom_fields) ? json_decode($this->custom_fields) : array();
+
+        $custom_fields[] = array(
+            'name'     => $field_name,
+            'value'    => $value,
+            'editor'   => $editor,
+            'required'   => $required
+        );
+
+        $this->custom_fields = json_encode($custom_fields);
+
+        return $this;
+    }
+
     /**
      * @param  string $id
      * @return SignatureRequest

library/HelloSign/AbstractSignatureRequestWrapper.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * HelloSign PHP SDK (https://github.com/HelloFax/hellosign-php-sdk/)
+ * HelloSign PHP SDK (https://github.com/hellosign/hellosign-php-sdk/)
  */
 
 /**
@@ -36,19 +36,26 @@
 abstract class AbstractSignatureRequestWrapper extends AbstractResource
 {
     /**
-     * Client id of the app
+     * Client ID of the API App
      *
      * @var string
      */
     protected $client_id = null;
 
     /**
-     * Related signature request
+     * Related SignatureRequest
      *
      * @var AbstractSignatureRequest
      */
     protected $request = null;
 
+    /**
+     * Disables the "Me (Now)" option for the person preparing the SignatureRequest.
+     *
+     * @var boolean
+     */
+    protected $skip_me_now = false;
+
     /**
      * Constructor
      *
@@ -82,7 +89,7 @@ public function getClientId()
     }
 
     /**
-     * include only if enabling embedded signing
+     * Include only if enabling embedded signing
      * when using EmbeddedSignatureRequest
      * with createUnclaimedDraftEmbeddedWithTemplate
      * @return static
@@ -123,6 +130,18 @@ public function isUsingTemplate()
         return $this->request instanceof TemplateSignatureRequest;
     }
 
+    /**
+       * @param  boolean $skip_me_now Set to true to disable the "Me (Now)" option
+       * for the preparer.
+       * @return static
+       * @ignore
+       */
+    public function enableSkipMeNow()
+    {
+        $this->skip_me_now = true;
+        return $this;
+    }
+
     /**
      * @return array
      * @ignore

library/HelloSign/Account.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * HelloSign PHP SDK (https://github.com/HelloFax/hellosign-php-sdk/)
+ * HelloSign PHP SDK (https://github.com/hellosign/hellosign-php-sdk/)
  */
 
 /**
@@ -57,31 +57,31 @@ class Account extends AbstractResource
     protected $email_address = null;
 
     /**
-     * The URL that HelloSign events will be POSTed to
+     * The URL that HelloSign Account events will be POSTed to
      *
      * @var string
      */
     protected $callback_url = null;
 
     /**
-     * If the user has a paid HelloSign license will return true
+     * If the user has a paid HelloSign subscription, will return true
      *
      * @var boolean
      */
     protected $is_paid_hs = false;
 
     /**
-     * If the user has a paid HelloFax license will return true
+     * If the user has a paid HelloFax subscription, will return true
      *
      * @var boolean
      */
     protected $is_paid_hf = false;
 
     /**
-     * An object detailing remaining monthly quotas
+     * An object detailing remaining quotas
      *
      * templates_left: API templates remaining
-     * api_signature_requests_left: API signature requests remaining
+     * api_signature_requests_left: API signature requests remaining for the month
      *
      * @var stdClass
      */