Updating documenation for User entity.

Updating docblock type for all options to be array<string,mixed>
TomorrowIdeas · Oct 12, 2021 · bfc48c2 · bfc48c2
1 parent 0f3a8d9
commit bfc48c2
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -399,7 +399,15 @@ The `TomorrowIdeas\Plaid\Entities\User` entity is used to represent your end use
 Example:
 
 ```php
-$token_user = new User($user->id, $user->name, $user->phone);
+$token_user = new User(
+	string $id,
+	?string $name = null,
+	?string $phone_number = null,
+	?string $phone_number_verified_time = null,
+	?string $email_address = null,
+	?string $ssn = null,
+	?string $date_of_birth = null
+)
 ```
 
 ### RecipientAddress

diff --git a/src/Resources/Accounts.php b/src/Resources/Accounts.php
@@ -32,7 +32,7 @@ public function list(string $access_token, array $options = []): object
 	 * Get Account balance.
 	 *
 	 * @param string $access_token
-	 * @param array<string,string> $options
+	 * @param array<string,mixed> $options
 	 * @throws PlaidRequestException
 	 * @return object
 	 */

diff --git a/src/Resources/Auth.php b/src/Resources/Auth.php
@@ -10,7 +10,7 @@ class Auth extends AbstractResource
 	 * Get Auth request.
 	 *
 	 * @param string $access_token
-	 * @param array<string,string> $options
+	 * @param array<string,mixed> $options
 	 * @throws PlaidRequestException
 	 * @return object
 	 */

diff --git a/src/Resources/Institutions.php b/src/Resources/Institutions.php
@@ -11,7 +11,7 @@ class Institutions extends AbstractResource
 	 *
 	 * @param string $institution_id
 	 * @param array<string> $country_codes
-	 * @param array<string,string> $options
+	 * @param array<string,mixed> $options
 	 * @throws PlaidRequestException
 	 * @return object
 	 */
@@ -36,7 +36,7 @@ public function get(string $institution_id, array $country_codes, array $options
 	 * @param integer $count
 	 * @param integer $offset
 	 * @param array<string> $country_codes
-	 * @param array<string,string> $options
+	 * @param array<string,mixed> $options
 	 * @throws PlaidRequestException
 	 * @return object
 	 */
@@ -62,7 +62,7 @@ public function list(int $count, int $offset, array $country_codes, array $optio
 	 * @param string $query
 	 * @param array<string> $products
 	 * @param array<string> $country_codes Possible values: US, GB, ES, NL, FR, IE, CA
-	 * @param array<string,string> $options
+	 * @param array<string,mixed> $options
 	 * @throws PlaidRequestException
 	 * @return object
 	 */

diff --git a/src/Resources/Investments.php b/src/Resources/Investments.php
@@ -11,7 +11,7 @@ class Investments extends AbstractResource
 	 * Get investment holdings.
 	 *
 	 * @param string $access_token
-	 * @param array<string,string> $options
+	 * @param array<string,mixed> $options
 	 * @throws PlaidRequestException
 	 * @return object
 	 */
@@ -35,7 +35,7 @@ public function listHoldings(string $access_token, array $options = []): object
 	 * @param string $access_token
 	 * @param DateTime $start_date
 	 * @param DateTime $end_date
-	 * @param array<string,string> $options
+	 * @param array<string,mixed> $options
 	 * @throws PlaidRequestException
 	 * @return object
 	 */

diff --git a/src/Resources/Liabilities.php b/src/Resources/Liabilities.php
@@ -10,7 +10,7 @@ class Liabilities extends AbstractResource
 	 * Get Liabilities request.
 	 *
 	 * @param string $access_token
-	 * @param array<string,string> $options
+	 * @param array<string,mixed> $options
 	 * @throws PlaidRequestException
 	 * @return object
 	 */

diff --git a/src/Resources/Reports.php b/src/Resources/Reports.php
@@ -12,7 +12,7 @@ class Reports extends AbstractResource
 	 *
 	 * @param array<string> $access_tokens
 	 * @param integer $days_requested
-	 * @param array<string,string> $options
+	 * @param array<string,mixed> $options
 	 * @throws PlaidRequestException
 	 * @return object
 	 */
@@ -36,7 +36,7 @@ public function createAssetReport(array $access_tokens, int $days_requested, arr
 	 *
 	 * @param string $asset_report_token
 	 * @param integer $days_requested
-	 * @param array<string,string> $options
+	 * @param array<string,mixed> $options
 	 * @throws PlaidRequestException
 	 * @return object
 	 */

diff --git a/src/Resources/Transactions.php b/src/Resources/Transactions.php
@@ -13,7 +13,7 @@ class Transactions extends AbstractResource
 	 * @param string $access_token
 	 * @param DateTime $start_date
 	 * @param DateTime $end_date
-	 * @param array<string,string> $options
+	 * @param array<string,mixed> $options
 	 * @throws PlaidRequestException
 	 * @return object
 	 */