Skip to content
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.

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

Even more PHPDoc fixes #843

Merged
merged 1 commit into from
Jan 30, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/Account.php
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ public function instanceUrl()
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return Account
* @return \Stripe\Account
*/
public static function retrieve($id = null, $opts = null)
{
Expand Down Expand Up @@ -139,7 +139,7 @@ public function reject($params = null, $opts = null)
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return StripeObject Object containing the response from the API.
* @return \Stripe\StripeObject Object containing the response from the API.
*/
public function deauthorize($clientId = null, $opts = null)
{
Expand Down
2 changes: 1 addition & 1 deletion lib/Balance.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class Balance extends SingletonApiResource
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return Balance
* @return \Stripe\Balance
*/
public static function retrieve($opts = null)
{
Expand Down
2 changes: 1 addition & 1 deletion lib/CreditNote.php
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ public function voidCreditNote($params = null, $opts = null)
}

/**
* @param string $id The ID of the credit note on which to retrieve the lines.
* @param string $id The ID of the credit note on which to retrieve the credit note line items.
* @param array|null $params
* @param array|string|null $opts
*
Expand Down
40 changes: 20 additions & 20 deletions lib/Customer.php
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public static function getSavedNestedResources()
* @param array|null $params
* @param array|string|null $opts
*
* @return Customer The updated customer.
* @return \Stripe\Customer The updated customer.
*/
public function deleteDiscount($params = null, $opts = null)
{
Expand All @@ -79,79 +79,79 @@ public function deleteDiscount($params = null, $opts = null)
}

/**
* @param string $id The ID of the customer on which to retrieve the balance transactions.
* @param string $id The ID of the customer on which to retrieve the customer balance transactions.
* @param array|null $params
* @param array|string|null $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Collection The list of balance transactions.
* @return \Stripe\Collection The list of customer balance transactions.
*/
public static function allBalanceTransactions($id, $params = null, $opts = null)
{
return self::_allNestedResources($id, static::PATH_BALANCE_TRANSACTIONS, $params, $opts);
}

/**
* @param string $id The ID of the customer on which to create the balance transaction.
* @param string $id The ID of the customer on which to create the customer balance transaction.
* @param array|null $params
* @param array|string|null $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\BalanceTransaction
* @return \Stripe\CustomerBalanceTransaction
*/
public static function createBalanceTransaction($id, $params = null, $opts = null)
{
return self::_createNestedResource($id, static::PATH_BALANCE_TRANSACTIONS, $params, $opts);
}

/**
* @param string $id The ID of the customer to which the balance transaction belongs.
* @param string $balanceTransactionId The ID of the balance transaction to retrieve.
* @param string $id The ID of the customer to which the customer balance transaction belongs.
* @param string $balanceTransactionId The ID of the customer balance transaction to retrieve.
* @param array|null $params
* @param array|string|null $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\BalanceTransaction
* @return \Stripe\CustomerBalanceTransaction
*/
public static function retrieveBalanceTransaction($id, $balanceTransactionId, $params = null, $opts = null)
{
return self::_retrieveNestedResource($id, static::PATH_BALANCE_TRANSACTIONS, $balanceTransactionId, $params, $opts);
}

/**
* @param string $id The ID of the customer to which the balance transaction belongs.
* @param string $balanceTransactionId The ID of the balance transaction to update.
* @param string $id The ID of the customer to which the customer balance transaction belongs.
* @param string $balanceTransactionId The ID of the customer balance transaction to update.
* @param array|null $params
* @param array|string|null $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\BalanceTransaction
* @return \Stripe\CustomerBalanceTransaction
*/
public static function updateBalanceTransaction($id, $balanceTransactionId, $params = null, $opts = null)
{
return self::_updateNestedResource($id, static::PATH_BALANCE_TRANSACTIONS, $balanceTransactionId, $params, $opts);
}

/**
* @param string $id The ID of the customer on which to retrieve the sources.
* @param string $id The ID of the customer on which to retrieve the payment sources.
* @param array|null $params
* @param array|string|null $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return \Stripe\Collection The list of sources.
* @return \Stripe\Collection The list of payment sources (AlipayAccount, BankAccount, BitcoinReceiver, Card or Source).
*/
public static function allSources($id, $params = null, $opts = null)
{
return self::_allNestedResources($id, static::PATH_SOURCES, $params, $opts);
}

/**
* @param string $id The ID of the customer on which to create the source.
* @param string $id The ID of the customer on which to create the payment source.
* @param array|null $params
* @param array|string|null $opts
*
Expand All @@ -165,8 +165,8 @@ public static function createSource($id, $params = null, $opts = null)
}

/**
* @param string $id The ID of the customer to which the source belongs.
* @param string $sourceId The ID of the source to delete.
* @param string $id The ID of the customer to which the payment source belongs.
* @param string $sourceId The ID of the payment source to delete.
* @param array|null $params
* @param array|string|null $opts
*
Expand All @@ -180,8 +180,8 @@ public static function deleteSource($id, $sourceId, $params = null, $opts = null
}

/**
* @param string $id The ID of the customer to which the source belongs.
* @param string $sourceId The ID of the source to retrieve.
* @param string $id The ID of the customer to which the payment source belongs.
* @param string $sourceId The ID of the payment source to retrieve.
* @param array|null $params
* @param array|string|null $opts
*
Expand All @@ -195,8 +195,8 @@ public static function retrieveSource($id, $sourceId, $params = null, $opts = nu
}

/**
* @param string $id The ID of the customer to which the source belongs.
* @param string $sourceId The ID of the source to update.
* @param string $id The ID of the customer to which the payment source belongs.
* @param string $sourceId The ID of the payment source to update.
* @param array|null $params
* @param array|string|null $opts
*
Expand Down
2 changes: 1 addition & 1 deletion lib/Dispute.php
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ class Dispute extends ApiResource
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return Dispute The closed dispute.
* @return \Stripe\Dispute The closed dispute.
*/
// TODO: add $params to standardize signature
public function close($opts = null)
Expand Down
2 changes: 1 addition & 1 deletion lib/EphemeralKey.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class EphemeralKey extends ApiResource
* @throws \Stripe\Exception\InvalidArgumentException if stripe_version is missing
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return EphemeralKey The created key.
* @return \Stripe\EphemeralKey The created key.
*/
public static function create($params = null, $opts = null)
{
Expand Down
6 changes: 3 additions & 3 deletions lib/Invoice.php
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ public function sendInvoice($params = null, $opts = null)
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return Invoice The upcoming invoice.
* @return \Stripe\Invoice The upcoming invoice.
*/
public static function upcoming($params = null, $opts = null)
{
Expand Down Expand Up @@ -216,13 +216,13 @@ public function voidInvoice($params = null, $opts = null)
}

/**
* @param string $id The ID of the invoice on which to retrieve the lins.
* @param string $id The ID of the invoice on which to retrieve the lines.
* @param array|null $params
* @param array|string|null $opts
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return Collection The list of lines (InvoiceLineItem).
* @return \Stripe\Collection The list of lines (InvoiceLineItem).
*/
public static function allLines($id, $params = null, $opts = null)
{
Expand Down
2 changes: 1 addition & 1 deletion lib/Issuing/Card.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ class Card extends \Stripe\ApiResource
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return CardDetails The card details associated with that issuing card.
* @return \Stripe\Issuing\CardDetails The card details associated with that issuing card.
*/
public function details($params = null, $opts = null)
{
Expand Down
2 changes: 1 addition & 1 deletion lib/Order.php
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public function pay($params = null, $opts = null)
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return OrderReturn The newly created return.
* @return \Stripe\OrderReturn The newly created return.
*/
public function returnOrder($params = null, $opts = null)
{
Expand Down
6 changes: 3 additions & 3 deletions lib/Source.php
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ class Source extends ApiResource
* @throws \Stripe\Exception\UnexpectedValueException if the source is not attached to a customer
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return Source The detached source.
* @return \Stripe\Source The detached source.
*/
public function detach($params = null, $opts = null)
{
Expand Down Expand Up @@ -126,7 +126,7 @@ public function detach($params = null, $opts = null)
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return Collection The list of source transactions.
* @return \Stripe\Collection The list of source transactions.
*/
public function sourceTransactions($params = null, $opts = null)
{
Expand All @@ -144,7 +144,7 @@ public function sourceTransactions($params = null, $opts = null)
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return Collection The list of source transactions.
* @return \Stripe\Collection The list of source transactions.
*/
public static function allSourceTransactions($id, $params = null, $opts = null)
{
Expand Down
4 changes: 2 additions & 2 deletions lib/SubscriptionItem.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class SubscriptionItem extends ApiResource
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return ApiResource
* @return \Stripe\UsageRecord
*/
public static function createUsageRecord($id, $params = null, $opts = null)
{
Expand All @@ -53,7 +53,7 @@ public static function createUsageRecord($id, $params = null, $opts = null)
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*
* @return Collection The list of usage record summaries.
* @return \Stripe\Collection The list of usage record summaries.
*/
public function usageRecordSummaries($params = null, $opts = null)
{
Expand Down
1 change: 0 additions & 1 deletion lib/SubscriptionSchedule.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
* @property int $created
* @property \Stripe\StripeObject|null $current_phase
* @property string $customer
* @property \Stripe\StripeObject $default_settings
* @property string $end_behavior
* @property mixed|null $invoice_settings
* @property bool $livemode
Expand Down