Add support for files.getUploadURLExternal and files.completeUploadExternal

.github/workflows/ci.yml

@@ -43,6 +43,7 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             fail-fast: false
+            max-parallel: 1 # Avoid rate-limit issue on Slack API
             matrix:
                 php-version: [ '8.0', '8.1', '8.2' ]
                 composer-flags: [ '' ]
@@ -69,4 +70,4 @@ jobs:
               env:
                   SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}
                   SLACK_TEST_CHANNEL: ${{ secrets.SLACK_TEST_CHANNEL }}
-                  CI: ${{ vars.CI }}
+                  CI: true

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changes between versions
 
+## Unreleased (2025)
+
+* Upgrade JanePHP generated code
+* Improve the Cursor paginated methods, add missing and remove obsoletes
+
 ## 4.7.1 (2024-06-28)
 
 * Upgrade JanePHP generated code

CONTRIBUTING.md

@@ -51,6 +51,30 @@ Run the tests using the following script:
 make test
 ```
 
+You need a Slack Application OAuth token to run all the tests.
+
+Scope are at least:
+
+- channels:history
+- channels:read
+- channels:write
+- chat:write
+- files:read
+- files:write
+- im:history
+- im:read
+- reactions:read
+- search:read
+- stars:read
+- usergroups:read
+- users:read
+
+Set the token in `phpunit.xml`:
+
+```xml
+<server name="SLACK_TOKEN" value="edit_me" />
+```
+
 ## Standard code
 
 Use [PHP CS fixer](https://cs.symfony.com/) to make your code compliant with

docs/2-usage.md

@@ -77,9 +77,6 @@ do {
 } while (!empty($cursor));
 ```
 
->Note: the virtual methods are not yet documented with PHPDoc so your IDE will
-not autocomplete them.
-
 ## Concrete examples
 
 Here are some real-life examples of interacting with the SDK:

generated/Client.php

@@ -2478,6 +2478,32 @@ public function filesCommentsDelete(array $formParameters = [], array $headerPar
         return $this->executeEndpoint(new Endpoint\FilesCommentsDelete($formParameters, $headerParameters), $fetch);
     }
 
+    /**
+     * Finishes an upload started with files.getUploadURLExternal.
+     *
+     * @param array $queryParameters {
+     *
+     * @var string $channel_id Channel ID where the file will be shared. If not specified the file will be private.
+     * @var string $channels comma-separated string of channel IDs where the file will be shared
+     * @var string $files JSON-encoded array of file ids and their corresponding (optional) titles
+     * @var string $initial_comment the message text introducing the file in specified channels
+     * @var string $thread_ts Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead. Also make sure to provide only one channel when using 'thread_ts'
+     *             }
+     *
+     * @param array $headerParameters {
+     *
+     * @var string $token Authentication token. Requires scope: `files:write:user`
+     *             }
+     *
+     * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
+     *
+     * @return Model\FilesCompleteUploadExternalPostResponse200|Model\FilesCompleteUploadExternalPostResponsedefault|\Psr\Http\Message\ResponseInterface|null
+     */
+    public function filesCompleteUploadExternal(array $queryParameters = [], array $headerParameters = [], string $fetch = self::FETCH_OBJECT)
+    {
+        return $this->executeEndpoint(new Endpoint\FilesCompleteUploadExternal($queryParameters, $headerParameters), $fetch);
+    }
+
     /**
      * Deletes a file.
      *
@@ -2500,6 +2526,25 @@ public function filesDelete(array $formParameters = [], array $headerParameters
         return $this->executeEndpoint(new Endpoint\FilesDelete($formParameters, $headerParameters), $fetch);
     }
 
+    /**
+     * Gets a URL for an edge external file upload.
+     *
+     * @param array $queryParameters {
+     *
+     * @var string $filename Name of the file being uploaded
+     * @var int    $length Size in bytes of the file being uploaded
+     * @var string $token Authentication token. Requires scope: `files:write`
+     *             }
+     *
+     * @param string $fetch Fetch mode to use (can be OBJECT or RESPONSE)
+     *
+     * @return Model\FilesGetUploadURLExternalGetResponse200|Model\FilesGetUploadURLExternalGetResponsedefault|\Psr\Http\Message\ResponseInterface|null
+     */
+    public function filesGetUploadURLExternal(array $queryParameters = [], string $fetch = self::FETCH_OBJECT)
+    {
+        return $this->executeEndpoint(new Endpoint\FilesGetUploadURLExternal($queryParameters), $fetch);
+    }
+
     /**
      * Gets information about a file.
      *

generated/Endpoint/FilesCompleteUploadExternal.php

@@ -0,0 +1,107 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of JoliCode's Slack PHP API project.
+ *
+ * (c) JoliCode <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace JoliCode\Slack\Api\Endpoint;
+
+class FilesCompleteUploadExternal extends \JoliCode\Slack\Api\Runtime\Client\BaseEndpoint implements \JoliCode\Slack\Api\Runtime\Client\Endpoint
+{
+    use \JoliCode\Slack\Api\Runtime\Client\EndpointTrait;
+
+    /**
+     * Finishes an upload started with files.getUploadURLExternal.
+     *
+     * @param array $queryParameters {
+     *
+     * @var string $channel_id Channel ID where the file will be shared. If not specified the file will be private.
+     * @var string $channels comma-separated string of channel IDs where the file will be shared
+     * @var string $files JSON-encoded array of file ids and their corresponding (optional) titles
+     * @var string $initial_comment the message text introducing the file in specified channels
+     * @var string $thread_ts Provide another message's ts value to upload this file as a reply. Never use a reply's ts value; use its parent instead. Also make sure to provide only one channel when using 'thread_ts'
+     *             }
+     *
+     * @param array $headerParameters {
+     *
+     * @var string $token Authentication token. Requires scope: `files:write:user`
+     *             }
+     */
+    public function __construct(array $queryParameters = [], array $headerParameters = [])
+    {
+        $this->queryParameters = $queryParameters;
+        $this->headerParameters = $headerParameters;
+    }
+
+    public function getMethod(): string
+    {
+        return 'POST';
+    }
+
+    public function getUri(): string
+    {
+        return '/files.completeUploadExternal';
+    }
+
+    public function getBody(\Symfony\Component\Serializer\SerializerInterface $serializer, $streamFactory = null): array
+    {
+        return [[], null];
+    }
+
+    public function getExtraHeaders(): array
+    {
+        return ['Accept' => ['application/json']];
+    }
+
+    public function getAuthenticationScopes(): array
+    {
+        return ['slackAuth'];
+    }
+
+    protected function getQueryOptionsResolver(): \Symfony\Component\OptionsResolver\OptionsResolver
+    {
+        $optionsResolver = parent::getQueryOptionsResolver();
+        $optionsResolver->setDefined(['channel_id', 'channels', 'files', 'initial_comment', 'thread_ts']);
+        $optionsResolver->setRequired(['files']);
+        $optionsResolver->setDefaults([]);
+        $optionsResolver->addAllowedTypes('channel_id', ['string']);
+        $optionsResolver->addAllowedTypes('channels', ['string']);
+        $optionsResolver->addAllowedTypes('files', ['string']);
+        $optionsResolver->addAllowedTypes('initial_comment', ['string']);
+        $optionsResolver->addAllowedTypes('thread_ts', ['string']);
+
+        return $optionsResolver;
+    }
+
+    protected function getHeadersOptionsResolver(): \Symfony\Component\OptionsResolver\OptionsResolver
+    {
+        $optionsResolver = parent::getHeadersOptionsResolver();
+        $optionsResolver->setDefined(['token']);
+        $optionsResolver->setRequired([]);
+        $optionsResolver->setDefaults([]);
+        $optionsResolver->addAllowedTypes('token', ['string']);
+
+        return $optionsResolver;
+    }
+
+    /**
+     * @return \JoliCode\Slack\Api\Model\FilesCompleteUploadExternalPostResponse200|\JoliCode\Slack\Api\Model\FilesCompleteUploadExternalPostResponsedefault|null
+     */
+    protected function transformResponseBody(\Psr\Http\Message\ResponseInterface $response, \Symfony\Component\Serializer\SerializerInterface $serializer, ?string $contentType = null)
+    {
+        $status = $response->getStatusCode();
+        $body = (string) $response->getBody();
+        if (200 === $status) {
+            return $serializer->deserialize($body, 'JoliCode\Slack\Api\Model\FilesCompleteUploadExternalPostResponse200', 'json');
+        }
+
+        return $serializer->deserialize($body, 'JoliCode\Slack\Api\Model\FilesCompleteUploadExternalPostResponsedefault', 'json');
+    }
+}

generated/Endpoint/FilesGetUploadURLExternal.php

@@ -0,0 +1,86 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of JoliCode's Slack PHP API project.
+ *
+ * (c) JoliCode <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace JoliCode\Slack\Api\Endpoint;
+
+class FilesGetUploadURLExternal extends \JoliCode\Slack\Api\Runtime\Client\BaseEndpoint implements \JoliCode\Slack\Api\Runtime\Client\Endpoint
+{
+    use \JoliCode\Slack\Api\Runtime\Client\EndpointTrait;
+
+    /**
+     * Gets a URL for an edge external file upload.
+     *
+     * @param array $queryParameters {
+     *
+     * @var string $filename Name of the file being uploaded
+     * @var int    $length Size in bytes of the file being uploaded
+     * @var string $token Authentication token. Requires scope: `files:write`
+     *             }
+     */
+    public function __construct(array $queryParameters = [])
+    {
+        $this->queryParameters = $queryParameters;
+    }
+
+    public function getMethod(): string
+    {
+        return 'GET';
+    }
+
+    public function getUri(): string
+    {
+        return '/files.getUploadURLExternal';
+    }
+
+    public function getBody(\Symfony\Component\Serializer\SerializerInterface $serializer, $streamFactory = null): array
+    {
+        return [[], null];
+    }
+
+    public function getExtraHeaders(): array
+    {
+        return ['Accept' => ['application/json']];
+    }
+
+    public function getAuthenticationScopes(): array
+    {
+        return ['slackAuth'];
+    }
+
+    protected function getQueryOptionsResolver(): \Symfony\Component\OptionsResolver\OptionsResolver
+    {
+        $optionsResolver = parent::getQueryOptionsResolver();
+        $optionsResolver->setDefined(['filename', 'length', 'token']);
+        $optionsResolver->setRequired([]);
+        $optionsResolver->setDefaults([]);
+        $optionsResolver->addAllowedTypes('filename', ['string']);
+        $optionsResolver->addAllowedTypes('length', ['int']);
+        $optionsResolver->addAllowedTypes('token', ['string']);
+
+        return $optionsResolver;
+    }
+
+    /**
+     * @return \JoliCode\Slack\Api\Model\FilesGetUploadURLExternalGetResponse200|\JoliCode\Slack\Api\Model\FilesGetUploadURLExternalGetResponsedefault|null
+     */
+    protected function transformResponseBody(\Psr\Http\Message\ResponseInterface $response, \Symfony\Component\Serializer\SerializerInterface $serializer, ?string $contentType = null)
+    {
+        $status = $response->getStatusCode();
+        $body = (string) $response->getBody();
+        if (200 === $status) {
+            return $serializer->deserialize($body, 'JoliCode\Slack\Api\Model\FilesGetUploadURLExternalGetResponse200', 'json');
+        }
+
+        return $serializer->deserialize($body, 'JoliCode\Slack\Api\Model\FilesGetUploadURLExternalGetResponsedefault', 'json');
+    }
+}

generated/Model/FilesCompleteUploadExternalPostResponse200.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of JoliCode's Slack PHP API project.
+ *
+ * (c) JoliCode <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace JoliCode\Slack\Api\Model;
+
+class FilesCompleteUploadExternalPostResponse200 extends \ArrayObject
+{
+    /**
+     * @var array
+     */
+    protected $initialized = [];
+    /**
+     * @var bool|null
+     */
+    protected $ok;
+
+    public function isInitialized($property): bool
+    {
+        return \array_key_exists($property, $this->initialized);
+    }
+
+    public function getOk(): ?bool
+    {
+        return $this->ok;
+    }
+
+    public function setOk(?bool $ok): self
+    {
+        $this->initialized['ok'] = true;
+        $this->ok = $ok;
+
+        return $this;
+    }
+}