PHPDoc fixes, CreditNote.previewLines, and autogen prep #837

richardm-stripe · 2020-01-23T16:48:28Z

r? @ob
cc @stripe/api-libraries @remi-stripe @cjavilla-stripe @marko-stripe
Changes:

Document missing properties on Session, CreditNote, Invoice, InvoiceItem, Subscription, and SubscriptionSchedule.
Undocument properties on SubscriptionSchedule that were removed in the latest API versions.
Add '.previewLines' method to CreditNote.
Adds more specific types for many docstrings. A full list of the PHPDoc changes is here.
Several formatting changes/reordering of methods. This is an artifact of autogeneration.

lib/EphemeralKey.php

lib/Invoice.php

lib/InvoiceItem.php

lib/Source.php

lib/Mandate.php

lib/PaymentMethod.php

lib/SubscriptionSchedule.php

remi-stripe

Amazing work, this is so exciting! I left a lot of nitpicky comments and some real blockers.

Also flaggign that I think we have the same problem as with other codegen-ed resources: we never touch the nested resources like CustomerBalanceTransaction and TaxId. I could be wrong, but if I'm correct, if you removed all resources files, then re-codegen you should see all the missing files. It's okay-ish if so for now and something we should fix across all codegen soon

remi-stripe · 2020-01-24T01:24:02Z

lib/Account.php

@@ -305,6 +358,7 @@ public function persons($params = null, $opts = null)
        return $obj;
    }

+


extra new line

remi-stripe · 2020-01-24T01:24:57Z

lib/Account.php

-            }
-        }
-        return $updateArr;
-    }


if we could easily put the override like that at the end of the file it'd be great

remi-stripe · 2020-01-24T01:25:08Z

lib/ApplicationFee.php

@@ -30,6 +30,7 @@ class ApplicationFee extends ApiResource
    use ApiOperations\NestedResource;
    use ApiOperations\Retrieve;

+


extra new line (won't flag others)

lib/CreditNote.php

lib/Customer.php

lib/Review.php

remi-stripe · 2020-01-24T01:53:58Z

lib/SetupIntent.php

@@ -13,14 +13,14 @@
 * @property int $created
 * @property string|null $customer
 * @property string|null $description
- * @property mixed|null $last_setup_error
+ * @property \Stripe\StripeObject|null $last_setup_error


Technically this is an Error object today not sure if we care

lib/Source.php

lib/SubscriptionSchedule.php

marko-stripe · 2020-01-24T13:56:40Z

Also flagging that I think we have the same problem as with other codegen-ed resources: we never touch the nested resources like CustomerBalanceTransaction and TaxId. I could be wrong, but if I'm correct, if you removed all resources files, then re-codegen you should see all the missing files. It's okay-ish if so for now and something we should fix across all codegen soon

I think that's right. Brian and Josh from Slack saw that issue when they were starting to generate stripe-hack based on stripe-php. They started to also include nested resources when generating the files and it looked like it worked well.

ob-stripe · 2020-01-31T18:24:40Z

Rebased on latest master and regenerated. I think the remaining diff is as small as it's going to get.

Changes are:

path constants for nested resources are moved next to the method definitions for nested resources
some changes in whitespace and method definition order due to overrides (we don't have fine grained control over where code snippets manually defined via overrides will end up)

ob-stripe · 2020-01-31T18:25:25Z

r? @cjavilla-stripe @remi-stripe @richardm-stripe

Just in case I missed anything, but I think we're ready to make the switch to codegen!

remi-stripe

OMG it's happening.

richardm-stripe · 2020-01-31T18:32:23Z

lgtm

cjavilla-stripe · 2020-01-31T18:34:21Z

I think we're good to go. Hard to see the blind spots but excited to see this. Awesome work @richardm-stripe, @ob-stripe, and @remi-stripe!!

ob-stripe · 2020-02-06T01:56:55Z

Released as 7.23.0.

richardm-stripe force-pushed the richardm-autogen branch 3 times, most recently from add478d to ca12071 Compare January 23, 2020 20:31