Merge branch 'master' into latest-codegen-master

Author: helenye-stripe

.github/workflows/ci.yml

@@ -22,7 +22,7 @@ jobs:
   php-cs-fixer:
     name: PHP-CS-Fixer
 
-    runs-on: ubuntu-latest
+    runs-on: "ubuntu-24.04"
 
     steps:
       - uses: actions/checkout@v3
@@ -35,7 +35,7 @@ jobs:
   phpstan:
     name: PHPStan
 
-    runs-on: ubuntu-latest
+    runs-on: "ubuntu-24.04"
 
     steps:
       - uses: extractions/setup-just@v2
@@ -68,7 +68,7 @@ jobs:
         run: just lint
 
   tests:
-    runs-on: ubuntu-latest
+    runs-on: "ubuntu-24.04"
 
     strategy:
       fail-fast: false
@@ -132,7 +132,7 @@ jobs:
       (github.event_name == 'workflow_dispatch' || github.event_name == 'push') &&
       startsWith(github.ref, 'refs/tags/v') &&
       endsWith(github.actor, '-stripe')
-    runs-on: ubuntu-latest
+    runs-on: "ubuntu-24.04"
     steps:
       - uses: actions/checkout@v2
       - uses: stripe/openapi/actions/notify-release@master

CONTRIBUTING.md

@@ -0,0 +1,25 @@
+
+# Contributing
+
+We welcome bug reports, feature requests, and code contributions in a pull request.
+
+For most pull requests, we request that you identify or create an associated issue that has the necessary context. We use these issues to reach agreement on an approach and save the PR author from having to redo work. Fixing typos or documentation issues likely do not need an issue; for any issue that introduces substantial code changes, changes the public interface, or if you aren't sure, please find or [create an issue](https://www.github.com/stripe/stripe-php/issues/new/choose).
+
+## Contributor License Agreement
+
+All contributors must sign the Contributor License Agreement (CLA) before we can accept their contribution. If you have not yet signed the agreement, you will be given an option to do so when you open a pull request. You can then sign by clicking on the badge in the comment from @CLAassistant.
+
+## Generated code
+
+This project has a combination of manually maintained code and code generated from our private code generator. If your contribution involves changes to generated code, please call this out in the issue or pull request as we will likely need to make a change to our code generator before accepting the contribution.
+
+To identify files with purely generated code, look for the comment `File generated from our OpenAPI spec.` at the start of the file. Generated blocks of code within hand-written files will be between comments that say `The beginning of the section generated from our OpenAPI spec` and `The end of the section generated from our OpenAPI spec`.
+
+## Compatibility with supported language and runtime versions
+
+This project supports [many different langauge and runtime versions](README.md#requirements) and we are unable to accept any contribution that does not work on _all_ supported versions. If, after discussing the approach in the associated issue, your change must use an API / feature that isn't available in all supported versions, please call this out explicitly in the issue or pull request so we can help figure out the best way forward.
+
+## Set up your dev environment
+
+Please refer to this project's [README.md](README.md#development) for instructions on how to set up your development environment.
+

README.md

@@ -248,6 +248,8 @@ New features and bug fixes are released on the latest major version of the Strip
 
 ## Development
 
+[Contribution guidelines for this project](CONTRIBUTING.md)
+
 We use [just](https://github.com/casey/just) for conveniently running development tasks. You can use them directly, or copy the commands out of the `justfile`. To our help docs, run `just`.
 
 To get started, install [Composer][composer]. For example, on Mac OS:

justfile

@@ -1,7 +1,7 @@
-import? '../sdk-codegen/justfile'
-
 set quiet
 
+import? '../sdk-codegen/utils.just'
+
 # make vendored executables callable directly
 export PATH := "vendor/bin:" + env_var('PATH')
 
@@ -26,10 +26,6 @@ ci-test autoload:
 format *args: install
     PHP_CS_FIXER_IGNORE_ENV=1 php-cs-fixer fix -v --using-cache=no {{ args }}
 
-# for backwards compatibility; ideally removed later
-[private]
-alias codegen-format := format
-
 # check formatting for, but don't modify, files
 format-check: (format "--dry-run")
 

lib/Util/Util.php

@@ -64,7 +64,7 @@ public static function convertToStripeObject($resp, $opts, $apiMode = 'v1')
                     if (\array_key_exists('type', $resp) && \array_key_exists($resp['type'], $eventTypes)) {
                         $class = $eventTypes[$resp['type']];
                     } else {
-                        $class = \Stripe\StripeObject::class;
+                        $class = \Stripe\V2\Event::class;
                     }
                 }
             } elseif (\array_key_exists('data', $resp) && \array_key_exists('next_page_url', $resp)) {

lib/V2/Event.php

@@ -3,14 +3,19 @@
 namespace Stripe\V2;
 
 /**
+ * Base class for V2 events.
+ *
+ * This is concrete for use in our generated tests. Events returned from the \Stripe\V2\Core\EventService
+ * will be a subtype of \Stripe\V2\Event.
+ *
  * @property string $id Unique identifier for the event.
  * @property string $object String representing the object's type. Objects of the same type share the same value of the object field.
  * @property int $created Time at which the object was created.
  * @property \Stripe\StripeObject $reason Reason for the event.
  * @property string $type The type of the event.
  * @property null|string $context The Stripe account of the event
  */
-abstract class Event extends \Stripe\ApiResource
+class Event extends \Stripe\ApiResource
 {
     const OBJECT_NAME = 'v2.core.event';
 }