✨feat: New example of get Pix bucket

Author: guilherme-cota-efi

examples/exclusives/pix/pixKeysBucket.php

@@ -0,0 +1,42 @@
+<?php
+
+/**
+ * Detailed endpoint documentation
+ * https://dev.efipay.com.br/docs/api-pix/endpoints-exclusivos-efi#consultar-baldes-de-fichas
+ */
+
+$autoload = realpath(__DIR__ . "/../../../vendor/autoload.php");
+if (!file_exists($autoload)) {
+    die("Autoload file not found or on path <code>$autoload</code>.");
+}
+require_once $autoload;
+
+use Efi\Exception\EfiException;
+use Efi\EfiPay;
+
+$optionsFile = __DIR__ . "/../../credentials/options.php";
+if (!file_exists($optionsFile)) {
+    die("Options file not found or on path <code>$options</code>.");
+}
+$options = include $optionsFile;
+
+try {
+    $api = new EfiPay($options);
+    $response = $api->pixKeysBucket();
+
+    if (isset($options["responseHeaders"]) && $options["responseHeaders"]) {
+        print_r("<pre>" . json_encode($response->body, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES) . "</pre>");
+        print_r("<pre>" . json_encode($response->headers, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES) . "</pre>");
+    } else {
+        print_r("<pre>" . json_encode($response, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES) . "</pre>");
+    }
+} catch (EfiException $e) {
+    print_r($e->code . "<br>");
+    print_r($e->error . "<br>");
+    print_r($e->errorDescription) . "<br>";
+    if (isset($options["responseHeaders"]) && $options["responseHeaders"]) {
+        print_r("<pre>" . json_encode($e->headers, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES) . "</pre>");
+    }
+} catch (Exception $e) {
+    print_r($e->getMessage());
+}

src/Efi/EfiPay.php

@@ -89,6 +89,7 @@
  * @method mixed medList(array $params)
  * @method mixed medDefense(array $params, array $body)
  * @method mixed pixGetReceipt(array $params)
+ * @method mixed pixKeysBucket()
  * @method mixed pixCreateDueCharge(array $params, array $body)
  * @method mixed pixUpdateDueCharge(array $params, array $body)
  * @method mixed pixDetailDueCharge(array $params)

src/Efi/Endpoints/Pix.php

@@ -280,6 +280,11 @@
             "method" => "get",
             "scope" => "gn.receipts.read"
         ],
+        "pixKeysBucket" => [
+            "route" => "/v2/gn/chaves/balde",
+            "method" => "get",
+            "scope" => "gn.keys.bucket.read"
+        ],
         "pixConfigWebhookRecurrenceAutomatic" => [
             "route" => "/v2/webhookrec",
             "method" => "put",