Sync complex package with main repository changes

README.md

@@ -2470,6 +2470,43 @@ try {
 }
 
 ```
+
+#### Get boards
+[See Jira API reference](https://developer.atlassian.com/cloud/jira/software/rest/#api-rest-agile-1-0-board-get)
+
+```php
+<?php
+require 'vendor/autoload.php';
+
+use JiraRestApi\Board\BoardService;
+
+try {
+  $results = [];
+  $startAt = 0;
+  $maxResults = 50; // maximum allowed for board queries
+
+  do {
+      $response = $this->boardService->getBoards([
+        'startAt' => $startAt,
+        'maxResults' => $maxResults
+      ]);
+
+      $results = [...$results, ...$response->getBoards()];
+
+      $startAt += $maxResults;
+
+  } while($startAt < $response->total);
+
+  var_dump($results);
+
+} catch (JiraRestApi\JiraException $e) {
+    print('Error Occured! ' . $e->getMessage());
+}
+
+```
+
+
+
 #### Get board info
 [See Jira API reference](https://developer.atlassian.com/cloud/jira/software/rest/#api-rest-agile-1-0-board-boardId-get)
 

composer.json

@@ -7,7 +7,7 @@
         "php": "^8.0",
         "ext-curl": "*",
         "ext-json": "*",
-        "netresearch/jsonmapper": "^3.0|^4.0|^5.0",
+        "netresearch/jsonmapper": "^4.2",
         "monolog/monolog": "^2.0|^3.0"
     },
     "suggest": {

src/Auth/AuthService.php

@@ -80,7 +80,7 @@ public function getSessionCookieValue()
      * @throws \Exception
      * @throws \JiraRestApi\JiraException
      */
-    public function __construct(ConfigurationInterface $configuration = null, LoggerInterface $logger = null, $path = './')
+    public function __construct(?ConfigurationInterface $configuration = null, ?LoggerInterface $logger = null, $path = './')
     {
         parent::__construct($configuration, $logger, $path);
         $this->setAPIUri($this->auth_api_uri);

src/Board/BoardService.php

@@ -14,7 +14,7 @@ class BoardService extends \JiraRestApi\JiraClient
 
     private $agileVersion = '1.0';
 
-    public function __construct(ConfigurationInterface $configuration = null, LoggerInterface $logger = null, $path = './')
+    public function __construct(?ConfigurationInterface $configuration = null, ?LoggerInterface $logger = null, $path = './')
     {
         parent::__construct($configuration, $logger, $path);
         $this->setAPIUri('/rest/agile/'.$this->agileVersion);
@@ -46,6 +46,31 @@ public function getBoardList($paramArray = []): ?\ArrayObject
         }
     }
 
+    /**
+     * Get list of boards with paginated results.
+     *
+     * @param array $paramArray
+     *
+     * @throws \JiraRestApi\JiraException
+     *
+     * @return PaginatedResult|null array of Board class
+     */
+    public function getBoards($paramArray = []): ?PaginatedResult
+    {
+        $json = $this->exec($this->uri.$this->toHttpQueryParameter($paramArray), null);
+
+        try {
+            return $this->json_mapper->map(
+                json_decode($json, false, 512, $this->getJsonOptions()),
+                new PaginatedResult()
+            );
+        } catch (\JsonException $exception) {
+            $this->log->error("Response cannot be decoded from json\nException: {$exception->getMessage()}");
+
+            return null;
+        }
+    }
+
     public function getBoard($id, $paramArray = []): ?Board
     {
         $json = $this->exec($this->uri.'/'.$id.$this->toHttpQueryParameter($paramArray), null);
@@ -122,6 +147,31 @@ public function getBoardSprints($boardId, $paramArray = []): ?\ArrayObject
         }
     }
 
+    /**
+     * Get list of boards with paginated results.
+     *
+     * @param array $paramArray
+     *
+     * @throws \JiraRestApi\JiraException
+     *
+     * @return PaginatedResult|null array of Board class
+     */
+    public function getSprintsForBoard($boardId, $paramArray = []): ?PaginatedResult
+    {
+        $json = $this->exec($this->uri.'/'.$boardId.'/sprint'.$this->toHttpQueryParameter($paramArray), null);
+
+        try {
+            return $this->json_mapper->map(
+                json_decode($json, false, 512, $this->getJsonOptions()),
+                new PaginatedResult()
+            );
+        } catch (\JsonException $exception) {
+            $this->log->error("Response cannot be decoded from json\nException: {$exception->getMessage()}");
+
+            return null;
+        }
+    }
+
     /**
      * @return \ArrayObject|Epic[]|null
      */

src/Board/PaginatedResult.php

@@ -0,0 +1,129 @@
+<?php
+
+namespace JiraRestApi\Board;
+
+/**
+ * Paginated Result object for BoardService.
+ */
+class PaginatedResult
+{
+    /**
+     * @var string
+     */
+    public $expand;
+
+    /**
+     * @var int
+     */
+    public $startAt;
+
+    /**
+     * @var int
+     */
+    public $maxResults;
+
+    /**
+     * @var int
+     */
+    public $total;
+
+    /**
+     * @var array
+     */
+    public $values;
+
+    /**
+     * @var bool
+     */
+    public $isLast;
+
+    /**
+     * @return int
+     */
+    public function getStartAt()
+    {
+        return $this->startAt;
+    }
+
+    /**
+     * @param int $startAt
+     */
+    public function setStartAt($startAt)
+    {
+        $this->startAt = $startAt;
+    }
+
+    /**
+     * @return int
+     */
+    public function getMaxResults()
+    {
+        return $this->maxResults;
+    }
+
+    /**
+     * @param int $maxResults
+     */
+    public function setMaxResults($maxResults)
+    {
+        $this->maxResults = $maxResults;
+    }
+
+    /**
+     * @return int
+     */
+    public function getTotal()
+    {
+        return $this->total;
+    }
+
+    /**
+     * @param int $total
+     */
+    public function setTotal($total)
+    {
+        $this->total = $total;
+    }
+
+    /**
+     * @return array
+     */
+    public function getValues()
+    {
+        return $this->values;
+    }
+
+    /**
+     * @param array $values
+     */
+    public function setValues($values)
+    {
+        $this->values = $values;
+    }
+
+    /**
+     * @param int $index
+     *
+     * @return mixed
+     */
+    public function getValue($index)
+    {
+        return $this->values[$index];
+    }
+
+    /**
+     * @return string
+     */
+    public function getExpand()
+    {
+        return $this->expand;
+    }
+
+    /**
+     * @param string $expand
+     */
+    public function setExpand($expand)
+    {
+        $this->expand = $expand;
+    }
+}

src/Component/Component.php

@@ -25,7 +25,7 @@ class Component implements \JsonSerializable
 
     public string $description;
 
-    public ?User $lead;
+    public ?User $lead = null;
 
     public string $leadUserName;
 

src/Configuration/AbstractConfiguration.php

@@ -64,6 +64,11 @@ abstract class AbstractConfiguration implements ConfigurationInterface
      */
     protected ?string $proxyPort = null;
 
+    /**
+     * Proxy type.
+     */
+    protected ?int $proxyType = null;
+
     /**
      * Proxy user.
      */
@@ -198,6 +203,11 @@ public function getProxyPort(): ?string
         return $this->proxyPort;
     }
 
+    public function getProxyType(): ?int
+    {
+        return $this->proxyType;
+    }
+
     public function getProxyUser(): ?string
     {
         return $this->proxyUser;

src/Configuration/ArrayConfiguration.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Created by PhpStorm.
  * User: keanor

src/Configuration/ConfigurationInterface.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Created by PhpStorm.
  * User: keanor
@@ -96,6 +97,11 @@ public function getProxyServer(): ?string;
      */
     public function getProxyPort(): ?string;
 
+    /**
+     * Proxy type.
+     */
+    public function getProxyType(): ?int;
+
     /**
      * Proxy user.
      */

src/Configuration/DotEnvConfiguration.php

@@ -37,6 +37,7 @@ public function __construct(string $path = '.')
         $this->curlOptVerbose = $this->env('CURLOPT_VERBOSE', false);
         $this->proxyServer = $this->env('PROXY_SERVER');
         $this->proxyPort = $this->env('PROXY_PORT');
+        $this->proxyType = $this->env('PROXY_TYPE');
         $this->proxyUser = $this->env('PROXY_USER');
         $this->proxyPassword = $this->env('PROXY_PASSWORD');
 

src/Epic/EpicService.php

@@ -11,7 +11,7 @@ class EpicService extends \JiraRestApi\JiraClient
     private $uri = '/epic';
     private $version = '1.0';
 
-    public function __construct(ConfigurationInterface $configuration = null, LoggerInterface $logger = null, $path = './')
+    public function __construct(?ConfigurationInterface $configuration = null, ?LoggerInterface $logger = null, $path = './')
     {
         parent::__construct($configuration, $logger, $path);
         $this->setAPIUri('/rest/agile/'.$this->version);

src/Issue/AgileIssueService.php

@@ -11,7 +11,7 @@ class AgileIssueService extends \JiraRestApi\JiraClient
 
     private $agileVersion = '1.0';
 
-    public function __construct(ConfigurationInterface $configuration = null, LoggerInterface $logger = null, $path = './')
+    public function __construct(?ConfigurationInterface $configuration = null, ?LoggerInterface $logger = null, $path = './')
     {
         parent::__construct($configuration, $logger, $path);
         $this->setAPIUri('/rest/agile/'.$this->agileVersion);

src/Issue/Comment.php

@@ -18,6 +18,9 @@ class Comment implements \JsonSerializable
     /** @var string */
     public $body;
 
+    /** @var string */
+    public $renderedBody;
+
     /** @var \JiraRestApi\Issue\Reporter */
     public $updateAuthor;
 

src/Issue/CustomField.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace JiraRestApi\Issue;
+
+class CustomField implements \JsonSerializable
+{
+    public int $id;
+
+    public string $name;
+
+    public string $description;
+
+    public array $type;
+
+    public string $searcherKey;
+
+    public array $projectIds;
+
+    public array $issueTypeIds;
+
+    public string $self;
+
+    public int $numericId;
+
+    public bool $isLocked;
+
+    public bool $isManaged;
+
+    public bool $isAllProjects;
+
+    public bool $isTrusted;
+
+    public int $projectsCount;
+
+    public int $screensCount;
+
+    public function jsonSerialize(): mixed
+    {
+        return array_filter(get_object_vars($this));
+    }
+}