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

Added and corrected @property phpdocs for API resources #427

Merged
merged 2 commits into from
Jan 29, 2018
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
19 changes: 10 additions & 9 deletions lib/Account.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@
*
* @property string $id
* @property string $object
* @property mixed $business_logo
* @property string $business_logo
* @property string $business_name
* @property mixed $business_url
* @property string $business_primary_color
* @property string $business_url
* @property bool $charges_enabled
* @property string $country
* @property int $created
* @property bool $debit_negative_balances
* @property mixed $decline_charge_on
* @property string $default_currency
Expand All @@ -20,18 +22,17 @@
* @property string $email
* @property mixed $external_accounts
* @property mixed $legal_entity
* @property bool $managed
* @property AttachedObject $metadata
* @property mixed $payout_schedule
* @property mixed $payout_statement_descriptor
* @property string $payout_statement_descriptor
* @property bool $payouts_enabled
* @property mixed $product_description
* @property mixed $statement_descriptor
* @property mixed $support_email
* @property mixed $support_phone
* @property string $product_description
* @property string $statement_descriptor
* @property string $support_email
* @property string $support_phone
* @property string $timezone
* @property mixed $tos_acceptance
* @property mixed $verification
* @property mixed $keys
*
* @package Stripe
*/
Expand Down
15 changes: 15 additions & 0 deletions lib/ApplicationFee.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@
/**
* Class ApplicationFee
*
* @property string $id
* @property string $object
* @property string $account
* @property int $amount
* @property int $amount_refunded
* @property string $application
* @property string $balance_transaction
* @property string $charge
* @property int $created
* @property string $currency
* @property bool $livemode
* @property string $originating_transaction
* @property bool $refunded
* @property Collection $refunds
*
* @package Stripe
*/
class ApplicationFee extends ApiResource
Expand Down
9 changes: 9 additions & 0 deletions lib/ApplicationFeeRefund.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@
/**
* Class ApplicationFeeRefund
*
* @property string $id
* @property string $object
* @property int $amount
* @property string $balance_transaction
* @property int $created
* @property string $currency
* @property string $fee
* @property AttachedObject $metadata
*
* @package Stripe
*/
class ApplicationFeeRefund extends ApiResource
Expand Down
6 changes: 3 additions & 3 deletions lib/Balance.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
* Class Balance
*
* @property string $object
* @property mixed $available
* @property bool $livedmode
* @property mixed $pending
* @property array $available
* @property bool $livemode
* @property array $pending
*
* @package Stripe
*/
Expand Down
2 changes: 1 addition & 1 deletion lib/BalanceTransaction.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
* @property int $created
* @property string $currency
* @property string $description
* @property float $exchange_rate
* @property int $fee
* @property mixed $fee_details
* @property int $net
* @property string $source
* @property mixed $sourced_transfers
* @property string $status
* @property string $type
*
Expand Down
16 changes: 16 additions & 0 deletions lib/BankAccount.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,22 @@
/**
* Class BankAccount
*
* @property string $id
* @property string $object
* @property string $account
* @property string $account_holder_name
* @property string $account_holder_type
* @property string $bank_name
* @property string $country
* @property string $currency
* @property string $customer
* @property bool $default_for_currency
* @property string $fingerprint
* @property string $last4
* @property AttachedObject $metadata
* @property string $routing_number
* @property string $status
*
* @package Stripe
*/
class BankAccount extends ExternalAccount
Expand Down
4 changes: 2 additions & 2 deletions lib/Card.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@
* @property string $country
* @property string $customer
* @property string $cvc_check
* @property string $dynamic_last4": null,
* @property string $dynamic_last4
* @property int $exp_month
* @property int $exp_year
* @property string $fingerprint
* @property string $funding
* @property string $last4
* @property mixed $metadata
* @property AttachedObject $metadata
* @property string $name
* @property string $tokenization_method
*
Expand Down
34 changes: 20 additions & 14 deletions lib/Charge.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,38 @@
* @property string $object
* @property int $amount
* @property int $amount_refunded
* @property mixed $application_fee
* @property string $application
* @property string $application_fee
* @property string $balance_transaction
* @property bool $captured
* @property int $created
* @property string $currency
* @property string $customer
* @property mixed $description
* @property mixed $destination
* @property string|null $dispute
* @property mixed $failure_code
* @property mixed $failure_message
* @property string $description
* @property string $destination
* @property string $dispute
* @property string $failure_code
* @property string $failure_message
* @property mixed $fraud_details
* @property mixed $invoice
* @property string $invoice
* @property bool $livemode
* @property mixed $metadata
* @property mixed $order
* @property AttachedObject $metadata
* @property string $on_behalf_of
* @property string $order
* @property mixed $outcome
* @property bool $paid
* @property mixed $receipt_email
* @property mixed $receipt_number
* @property string $receipt_email
* @property string $receipt_number
* @property bool $refunded
* @property mixed $refunds
* @property Collection $refunds
* @property string $review
* @property mixed $shipping
* @property mixed $source
* @property mixed $source_transfer
* @property mixed $statement_descriptor
* @property string $source_transfer
* @property string $statement_descriptor
* @property string $status
* @property string $transfer
* @property string $transfer_group
*
* @package Stripe
*/
Expand Down
15 changes: 15 additions & 0 deletions lib/Coupon.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@
/**
* Class Coupon
*
* @property string $id
* @property string $object
* @property int $amount_off
* @property int $created
* @property string $currency
* @property string $duration
* @property int $duration_in_months
* @property bool $livemode
* @property int $max_redemptions
* @property AttachedObject $metadata
* @property int $percent_off
* @property int $redeem_by
* @property int $times_redeemed
* @property bool $valid
*
* @package Stripe
*/
class Coupon extends ApiResource
Expand Down
2 changes: 1 addition & 1 deletion lib/Customer.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* @property mixed $discount
* @property string $email
* @property bool $livemode
* @property array $metadata
* @property AttachedObject $metadata
* @property mixed $shipping
* @property Collection $sources
* @property Collection $subscriptions
Expand Down
2 changes: 1 addition & 1 deletion lib/Dispute.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* @property mixed $evidence_details
* @property bool $is_charge_refundable
* @property bool $livemode
* @property mixed $metadata
* @property AttachedObject $metadata
* @property string $reason
* @property string $status
*
Expand Down
2 changes: 1 addition & 1 deletion lib/Event.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
* @property mixed $data
* @property bool $livemode
* @property int $pending_webhooks
* @property string $request
* @property mixed $request
* @property string $type
*
* @package Stripe
Expand Down
36 changes: 36 additions & 0 deletions lib/Invoice.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,42 @@
/**
* Class Invoice
*
* @property string $id
* @property string $object
* @property int $amount_due
* @property int $application_fee
* @property int $attempt_count
* @property bool $attempted
* @property string $billing
* @property string $charge
* @property bool $closed
* @property string $currency
* @property string $customer
* @property int $date
* @property string $description
* @property mixed $discount
* @property int $due_date
* @property int $ending_balance
* @property bool $forgiven
* @property Collection $lines
* @property bool $livemode
* @property AttachedObject $metadata
* @property int $next_payment_attempt
* @property string $number
* @property bool $paid
* @property int $period_end
* @property int $period_start
* @property string $receipt_number
* @property int $starting_balance
* @property string $statement_descriptor
* @property string $subscription
* @property int $subscription_proration_date
* @property int $subtotal
* @property int $tax
* @property float $tax_percent
* @property int $total
* @property int $webhooks_delivered_at
*
* @package Stripe
*/
class Invoice extends ApiResource
Expand Down
18 changes: 18 additions & 0 deletions lib/InvoiceItem.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,24 @@
/**
* Class InvoiceItem
*
* @property string $id
* @property string $object
* @property int $amount
* @property string $currency
* @property string $customer
* @property int $date
* @property string $description
* @property bool $discountable
* @property string $invoice
* @property bool $livemode
* @property AttachedObject $metadata
* @property array $period
* @property mixed $plan
* @property bool $proration
* @property int $quantity
* @property string $subscription
* @property string $subscription_item
*
* @package Stripe
*/
class InvoiceItem extends ApiResource
Expand Down
24 changes: 24 additions & 0 deletions lib/Order.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,30 @@
/**
* Class Order
*
* @property string $id
* @property string $object
* @property int $amount
* @property int $amount_returned
* @property string $application
* @property int $application_fee
* @property string $charge
* @property int $created
* @property string $currency
* @property string $customer
* @property string $email
* @property string $external_coupon_code
* @property mixed $items
* @property bool $livemode
* @property AttachedObject $metadata
* @property Collection $returns
* @property string $selected_shipping_method
* @property mixed $shipping
* @property mixed $shipping_methods
* @property string $status
* @property mixed $status_transitions
* @property int $updated
* @property string $upstream_id
*
* @package Stripe
*/
class Order extends ApiResource
Expand Down
22 changes: 11 additions & 11 deletions lib/Plan.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@
*
* @package Stripe
*
* @property $id
* @property $object
* @property $amount
* @property $created
* @property $currency
* @property $interval
* @property $interval_count
* @property $livemode
* @property string $id
* @property string $object
* @property int $amount
* @property int $created
* @property string $currency
* @property string $interval
* @property int $interval_count
* @property bool $livemode
* @property AttachedObject $metadata
* @property $name
* @property $statement_descriptor
* @property $trial_period_days
* @property string $name
* @property string $statement_descriptor
* @property int $trial_period_days
*/
class Plan extends ApiResource
{
Expand Down
18 changes: 18 additions & 0 deletions lib/Product.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,24 @@
/**
* Class Product
*
* @property string $id
* @property string $object
* @property bool $active
* @property string[] $attributes
* @property string $caption
* @property int $created
* @property string[] $deactivate_on
* @property string $description
* @property array $images
* @property bool $livemode
* @property AttachedObject $metadata
* @property string $name
* @property mixed $package_dimensions
* @property bool $shippable
* @property Collection $skus
* @property int $updated
* @property string $url
*
* @package Stripe
*/
class Product extends ApiResource
Expand Down
Loading