Release v2.5.1

.github/workflows/aqua.yml

@@ -17,20 +17,20 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           show-progress: false
 
       - name: Authenticate to Google Cloud
         id: gcloud-auth
-        uses: google-github-actions/auth@v2
+        uses: google-github-actions/auth@7c6bc770dae815cd3e89ee6cdf493a5fab2cc093 # v3.0.0
         with:
           token_format: access_token
           workload_identity_provider: projects/699052769907/locations/global/workloadIdentityPools/github-identity-pool-shared/providers/github-identity-provider-shared  # yamllint disable-line
           service_account: github-gar-alma-php-client@lyrical-carver-335213.iam.gserviceaccount.com
 
       - name: Authenticate to Artifact Registry
-        uses: docker/login-action@v3
+        uses: docker/login-action@184bdaa0721073962dff0199f1fb9940f07167d1 # v3.5.0
         with:
           registry: europe-docker.pkg.dev
           username: oauth2accesstoken

.github/workflows/backport-pull-request.yml

@@ -17,7 +17,7 @@ jobs:
 
     steps:
 
-        - uses: actions/checkout@v4
+        - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
           with:
             ref: develop
 
@@ -28,7 +28,7 @@ jobs:
             git reset --hard main
 
         - name: Create Pull Request
-          uses: peter-evans/create-pull-request@v7
+          uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
           with:
             commit-message: 'chore: backport main to develop'
             title: Backport main to develop

.github/workflows/ci.yml

@@ -33,12 +33,12 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
 
       - name: Setup PHP
-        uses: shivammathur/setup-php@v2
+        uses: shivammathur/setup-php@ec406be512d7077f68eed36e63f4d91bc006edc4 # 2.35.4
         with:
           php-version: ${{ matrix.php }}
           tools: composer:v2

.github/workflows/hotfix-pull-request.yml

@@ -15,18 +15,18 @@ jobs:
 
     steps:
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           ref: main
 
       - name: Release drafter
-        uses: release-drafter/release-drafter@v6
+        uses: release-drafter/release-drafter@b1476f6e6eb133afa41ed8589daba6dc69b4d3f5 # v6.1.0
         id: release-drafter
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Update release draft
-        uses: actions/github-script@v7
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
         with:
           script: |
             const { owner, repo } = context.repo;
@@ -39,7 +39,7 @@ jobs:
             });
 
       - name: Update CHANGELOG.md file
-        uses: stefanzweifel/changelog-updater-action@v1
+        uses: stefanzweifel/changelog-updater-action@a938690fad7edf25368f37e43a1ed1b34303eb36 # v1.12.0
         with:
           latest-version: ${{ steps.release-drafter.outputs.tag_name }}
           release-notes: "### 🐛 Bug Fixes\n ${{ inputs.changelog-message }}\n"
@@ -49,7 +49,7 @@ jobs:
           ./scripts/update-files-with-release-version.sh ${{ steps.release-drafter.outputs.tag_name }}
 
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v7
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
         with:
           commit-message: 'chore: update version'
           title: Release ${{ steps.release-drafter.outputs.tag_name }}

.github/workflows/pr-labeler.yml

@@ -11,6 +11,6 @@ jobs:
 
     runs-on: ubuntu-24.04
     steps:
-      - uses: TimonVS/pr-labeler-action@v5
+      - uses: TimonVS/pr-labeler-action@f9c084306ce8b3f488a8f3ee1ccedc6da131d1af # v5
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release-publish.yml

@@ -15,7 +15,7 @@ jobs:
 
     steps:
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
       - name: Install taskfile.dev
         uses: arduino/setup-task@v2
@@ -85,7 +85,7 @@ jobs:
             https://uploads.github.com/repos/${{ github.repository }}/releases/${{ steps.fetch-release-draft.outputs.id }}/assets?name=alma-php-client.zip
 
       - name: Publish Github release
-        uses: actions/github-script@v7
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
         with:
           # target_commitish is set to refs/heads/develop by release-drafter as we need to retrieve pull requests merged into develop
           # We need to override it to refs/heads/main to point to the last commit of main branch instead of develop branch
@@ -102,18 +102,18 @@ jobs:
             });
 
       - name: Format release notes for Slack
-        uses: LoveToKnow/slackify-markdown-action@v1.1.1
+        uses: LoveToKnow/slackify-markdown-action@698a1d4d0ff1794152a93c03ee8ca5e03a310d4e # v1.1.1
         id: slack-markdown-release-notes
         with:
           text: |
             New release of ${{ github.repository }}, **[${{ steps.fetch-release-draft.outputs.name }}](https://github.com/${{ github.repository }}/releases/tag/${{ steps.fetch-release-draft.outputs.name }})**:
 
             ${{ steps.fetch-release-draft.outputs.body }}
 
-            cc <@france.berut> <@khadija.cherif>
+            cc <@khadija.cherif>
 
       - name: Send changelog to Slack
-        uses: slackapi/slack-github-action@v2.0.0
+        uses: slackapi/slack-github-action@91efab103c0de0a537f72a35f6b8cda0ee76bf0a # v2.1.1
         with:
           method: chat.postMessage
           token: ${{ secrets.SLACK_RELEASE_CHANGELOG_BOT_TOKEN }}

.github/workflows/release-pull-request.yml

@@ -10,7 +10,7 @@ jobs:
 
     steps:
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           ref: main
           persist-credentials: false
@@ -24,7 +24,7 @@ jobs:
           git reset --hard develop
 
       - name: Create release draft
-        uses: release-drafter/release-drafter@v6
+        uses: release-drafter/release-drafter@b1476f6e6eb133afa41ed8589daba6dc69b4d3f5 # v6.1.0
         id: release-drafter
         with:
           # release-drafter should be based on develop to get the correct content as pull requests are merged into develop
@@ -35,7 +35,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Update CHANGELOG.md
-        uses: stefanzweifel/changelog-updater-action@v1
+        uses: stefanzweifel/changelog-updater-action@a938690fad7edf25368f37e43a1ed1b34303eb36 # v1.12.0
         with:
           latest-version: ${{ steps.release-drafter.outputs.tag_name }}
           release-notes: ${{ steps.release-drafter.outputs.body }}
@@ -47,15 +47,15 @@ jobs:
       # If using default Github token, the created pull request won't trigger workflows with pull_request event
       # See https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#triggering-further-workflow-runs
       - name: Generate Github token to create PR
-        uses: actions/create-github-app-token@v1
+        uses: actions/create-github-app-token@a8d616148505b5069dccd32f177bb87d7f39123b # v2.1.1
         id: github-token
         with:
           app-id: ${{ secrets.ALMA_CREATE_TEAM_PRS_APP_ID }}
           private-key: ${{ secrets.ALMA_CREATE_TEAM_PRS_APP_PEM }}
           repositories: alma-php-client
 
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v7
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
         with:
           token: ${{ steps.github-token.outputs.token }}
           commit-message: 'chore: update version'

CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## v2.5.1 - 2025-09-01
+
+### Changes
+
+- Add DataExports endpoints (#137)
+
+#### Contributors
+
+@Francois-Gomis, @alma-renovate-bot[bot], @carine-bonnafous, @joyet-simon, @martinfobian, @remi-zuffinetti, [alma-renovate-bot[bot]](https://github.com/apps/alma-renovate-bot) and [github-actions[bot]](https://github.com/apps/github-actions)
+
 ## v2.5.0 - 2025-01-30
 
 ### Changes
@@ -220,6 +230,7 @@
 
 
 
+
   ```
 * Add fields and docs to the Payment entity
 * Add a Refund entity and extract refunds data within the Payment entity constructor

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "alma/alma-php-client",
   "description": "PHP API client for the Alma payments API",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "type": "library",
   "require": {
     "php": "^5.6 || ~7.0 || ~7.1 || ~7.2 || ~7.3 || ~7.4 || ~8.0 || ~8.1 || ~8.2 || ~8.3",

src/Client.php

@@ -30,7 +30,7 @@
 
 class Client
 {
-    const VERSION = '2.5.0';
+    const VERSION = '2.5.1';
 
     const LIVE_MODE = 'live';
     const TEST_MODE = 'test';
@@ -70,6 +70,11 @@ class Client
      * @var Endpoints\Insurance
      */
     public $insurance;
+
+    /**
+     * @var Endpoints\DataExports
+     */
+    public $dataExports;
     /*************************/
     /**
      * @var Endpoints\Configuration
@@ -155,6 +160,7 @@ private function initEndpoints()
         $this->shareOfCheckout = new Endpoints\ShareOfCheckout($this->context);
         $this->webhooks = new Endpoints\Webhooks($this->context);
         $this->insurance = new Endpoints\Insurance($this->context);
+        $this->dataExports = new Endpoints\DataExports($this->context);
         $this->configuration = new Endpoints\Configuration($this->context);
     }
 

src/Endpoints/DataExports.php

@@ -0,0 +1,100 @@
+<?php
+/**
+ * Copyright (c) 2018 Alma / Nabla SAS
+ *
+ * THE MIT LICENSE
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
+ * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+ * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ *
+ * @author    Alma / Nabla SAS <contact@getalma.eu>
+ * @copyright Copyright (c) 2018 Alma / Nabla SAS
+ * @license   https://opensource.org/licenses/MIT The MIT License
+ *
+ */
+
+namespace Alma\API\Endpoints;
+
+use Alma\API\Entities\DataExport;
+use Alma\API\Exceptions\ParametersException;
+use Alma\API\Exceptions\RequestException;
+use Alma\API\ParamsError;
+use Alma\API\RequestError;
+
+class DataExports extends Base
+{
+    const DATA_EXPORTS_PATH = '/v1/data-exports';
+    const ACCEPTED_FORMAT = ['csv', 'xlsx'];
+
+    /**
+     * @param $data
+     *
+     * @return DataExport
+     *
+     * @throws RequestException|RequestError
+     */
+    public function create($data)
+    {
+        $res = $this->request(self::DATA_EXPORTS_PATH)->setRequestBody($data)->post();
+
+        if ($res->isError()) {
+            throw new RequestException($res->errorMessage, null, $res);
+        }
+
+        return new DataExport($res->json);
+    }
+
+    /**
+     * @param $reportId
+     *
+     * @return DataExport
+     *
+     * @throws RequestException|RequestError
+     */
+    public function fetch($reportId)
+    {
+        $res = $this->request(self::DATA_EXPORTS_PATH . '/' . $reportId)->get();
+
+        if ($res->isError()) {
+            throw new RequestException($res->errorMessage, null, $res);
+        }
+
+        return new DataExport($res->json);
+    }
+
+    /**
+     * @param $reportId
+     *
+     * @param string $format only csv or xlsx
+     *
+     * @return mixed
+     *
+     * @throws RequestException|RequestError|ParametersException
+     */
+    public function download($reportId, $format)
+    {
+        if (!in_array($format, self::ACCEPTED_FORMAT)) {
+            throw new ParametersException("Invalid format: $format. Accepted format are: " . implode(', ', self::ACCEPTED_FORMAT));
+        }
+
+        $res = $this->request(self::DATA_EXPORTS_PATH . '/' . $reportId)
+            ->setQueryParams(['format' => $format])
+            ->get();
+
+        if ($res->isError()) {
+            throw new RequestException($res->errorMessage, null, $res);
+        }
+
+        return $res->responseFile;
+    }
+}