feat: atualizar para v301

AlexandreBellas · Sep 4, 2024 · fa74803 · fa74803
1 parent a457aae
commit fa74803
Show file tree

Hide file tree

Showing 14 changed files with 194 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 Pacote de integração com a [API v3 do ERP Bling](https://developer.bling.com.br)
 para PHP 8.2+. O mais completo existente.
 
-Atualizado com a versão `v300` da API ([veja o registro de alterações](https://developer.bling.com.br/changelogs#2024-03-13)).
+Atualizado com a versão `v301` da API ([veja o registro de alterações](https://developer.bling.com.br/changelogs#2024-05-22)).
 
 ## Instalação
 
@@ -36,7 +36,7 @@ projeto de demonstração](https://github.com/AlexandreBellas/bling-erp-api-php/
 
 ## Entidades disponíveis
 
-Todas as entidades do Bling atualmente são permitidas para interação. São elas:
+Quase todas as entidades do Bling atualmente são permitidas para interação. São elas:
 
 - [x] Borderos (`->borderos`)
 - [x] Campos customizados (`->camposCustomizados`)
@@ -54,6 +54,7 @@ Todas as entidades do Bling atualmente são permitidas para interação. São el
 - [x] Empresas (`->empresas`)
 - [x] Estoques (`->estoques`)
 - [x] Formas de pagamento (`->formasDePagamento`)
+- [ ] Grupos de produtos (`->gruposDeProdutos`)
 - [x] Homologação (`->homologacao`)
 - [x] Logísticas (`->logisticas`)
 - [x] Logísticas - Etiquetas (`->logisticasEtiquetas`)
@@ -65,13 +66,15 @@ Todas as entidades do Bling atualmente são permitidas para interação. São el
 - [x] Notas Fiscais de Serviço Eletrônicas (`->nfses`)
 - [x] Notas Fiscais Eletrônicas (`->nfes`)
 - [x] Notificações (`->notificacoes`)
+- [ ] Ordens de produção (`->ordensDeProducao`)
 - [x] Pedidos - Compras (`->pedidosCompras`)
 - [x] Pedidos - Vendas (`->pedidosVendas`)
 - [x] Produtos (`->produtos`)
 - [x] Produtos - Estruturas (`->produtosEstruturas`)
 - [x] Produtos - Fornecedores (`->produtosFornecedores`)
 - [x] Produtos - Lojas (`->produtosLojas`)
 - [x] Produtos - Variações (`->produtosVariacoes`)
+- [ ] Propostas comerciais (`->propostasComerciais`)
 - [x] Situações (`->situacoes`)
 - [x] Situações - Módulos (`->situacoesModulos`)
 - [x] Situações - Transições (`->situacoesTransicoes`)

diff --git a/composer.json b/composer.json
@@ -8,6 +8,7 @@
     "psr-4": {
       "AleBatistella\\BlingErpApi\\": "./src/",
       "AleBatistella\\BlingErpApi\\Entities\\Shared\\": "./src/Entities/@shared/",
+      "AleBatistella\\BlingErpApi\\Entities\\ContasPagar\\Schema\\Shared\\": "./src/Entities/ContasPagar/Schema/@shared/",
       "AleBatistella\\BlingErpApi\\Entities\\ContasReceber\\Schema\\Shared\\": "./src/Entities/ContasReceber/Schema/@shared/"
     },
     "files": [

diff --git a/src/Entities/@shared/DTO/Request/QueryParams.php b/src/Entities/@shared/DTO/Request/QueryParams.php
@@ -12,19 +12,20 @@
    *
    * @param array<string, string|string[]|int|int[]|\DateTimeInterface> $content
    */
-  public function __construct(public array $content)
-  {
-  }
+  public function __construct(public array $content) {}
 
   /**
    * Prepara um parâmetro de data para chamada do repositório.
    *
    * @param \DateTimeInterface|string|null $param Parâmetro do tipo `string`, `\DateTimeInterface` ou `null`
+   * @param bool $shouldIncludeTime Define se a `string` de retorno deve incluir horas caso `$param` seja do tipo `\DateTimeInterface`
    *
    * @return string|null
    */
-  protected function prepareStringOrDateParam(\DateTimeInterface|string|null $param): string|null
-  {
+  protected function prepareStringOrDateParam(
+    \DateTimeInterface|string|null $param,
+    bool $shouldIncludeTime = false
+  ): string|null {
     if (is_null($param)) {
       return null;
     }
@@ -33,6 +34,10 @@ protected function prepareStringOrDateParam(\DateTimeInterface|string|null $para
       return $param;
     }
 
-    return convertDateToString($param);
+    if (!$shouldIncludeTime) {
+      return convertDateToString($param);
+    }
+
+    return convertDateTimeToString($param);
   }
 }
diff --git a/src/Entities/ContasPagar/Schema/@shared/ContasPagarOcorrenciaDTO.php b/src/Entities/ContasPagar/Schema/@shared/ContasPagarOcorrenciaDTO.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace AleBatistella\BlingErpApi\Entities\ContasPagar\Schema\Shared;
+
+use AleBatistella\BlingErpApi\Entities\Shared\BaseResponseObject;
+use AleBatistella\BlingErpApi\Exceptions\BlingParseResponsePayloadException;
+
+readonly class ContasPagarOcorrenciaDTO extends BaseResponseObject
+{
+    /**
+     * Constrói o objeto.
+     * 
+     * @param int $tipo
+     * @param ?bool $considerarDiasUteis
+     * @param int $diaVencimento
+     * @param ?string $dataLimite
+     */
+    public function __construct(
+        public int $tipo,
+        public ?bool $considerarDiasUteis,
+        public int $diaVencimento,
+        public ?string $dataLimite
+    ) {}
+
+    /**
+     * @inheritDoc
+     */
+    public static function from(array $attributes): static
+    {
+        $allowedTypes = [3, 4, 5, 6, 7, 8];
+        if (!array_key_exists('tipo', $attributes) || !in_array($attributes['tipo'], $allowedTypes)) {
+            throw new BlingParseResponsePayloadException($attributes);
+        }
+
+        return parent::from($attributes);
+    }
+}
diff --git a/src/Entities/ContasPagar/Schema/@shared/ContasPagarOcorrenciaParceladaDTO.php b/src/Entities/ContasPagar/Schema/@shared/ContasPagarOcorrenciaParceladaDTO.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace AleBatistella\BlingErpApi\Entities\ContasPagar\Schema\Shared;
+
+use AleBatistella\BlingErpApi\Entities\Shared\BaseResponseObject;
+use AleBatistella\BlingErpApi\Exceptions\BlingParseResponsePayloadException;
+
+readonly class ContasPagarOcorrenciaParceladaDTO extends BaseResponseObject
+{
+    /**
+     * Constrói o objeto.
+     * 
+     * @param int $tipo
+     * @param ?bool $considerarDiasUteis
+     * @param int $diaVencimento
+     * @param ?int $numeroParcelas
+     */
+    public function __construct(
+        public int $tipo,
+        public ?bool $considerarDiasUteis,
+        public int $diaVencimento,
+        public ?int $numeroParcelas
+    ) {}
+
+    /**
+     * @inheritDoc
+     */
+    public static function from(array $attributes): static
+    {
+        if (!array_key_exists('tipo', $attributes) || $attributes['tipo'] !== 2) {
+            throw new BlingParseResponsePayloadException($attributes);
+        }
+
+        return parent::from($attributes);
+    }
+}
diff --git a/src/Entities/ContasPagar/Schema/@shared/ContasPagarOcorrenciaSemanalDTO.php b/src/Entities/ContasPagar/Schema/@shared/ContasPagarOcorrenciaSemanalDTO.php
@@ -0,0 +1,36 @@
+<?php
+
+namespace AleBatistella\BlingErpApi\Entities\ContasPagar\Schema\Shared;
+
+use AleBatistella\BlingErpApi\Entities\Shared\BaseResponseObject;
+use AleBatistella\BlingErpApi\Exceptions\BlingParseResponsePayloadException;
+
+readonly class ContasPagarOcorrenciaSemanalDTO extends BaseResponseObject
+{
+    /**
+     * Constrói o objeto.
+     * 
+     * @param int $tipo
+     * @param ?bool $considerarDiasUteis
+     * @param int $diaSemanaVencimento
+     * @param ?string $dataLimite
+     */
+    public function __construct(
+        public int $tipo,
+        public ?bool $considerarDiasUteis,
+        public int $diaSemanaVencimento,
+        public ?string $dataLimite
+    ) {}
+
+    /**
+     * @inheritDoc
+     */
+    public static function from(array $attributes): static
+    {
+        if (!array_key_exists('tipo', $attributes) || $attributes['tipo'] !== 9) {
+            throw new BlingParseResponsePayloadException($attributes);
+        }
+
+        return parent::from($attributes);
+    }
+}
diff --git a/src/Entities/ContasPagar/Schema/@shared/ContasPagarOcorrenciaUnicaDTO.php b/src/Entities/ContasPagar/Schema/@shared/ContasPagarOcorrenciaUnicaDTO.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace AleBatistella\BlingErpApi\Entities\ContasPagar\Schema\Shared;
+
+use AleBatistella\BlingErpApi\Entities\Shared\BaseResponseObject;
+use AleBatistella\BlingErpApi\Exceptions\BlingParseResponsePayloadException;
+
+readonly class ContasPagarOcorrenciaUnicaDTO extends BaseResponseObject
+{
+    /**
+     * Constrói o objeto.
+     * 
+     * @param int $tipo
+     */
+    public function __construct(
+        public int $tipo
+    ) {}
+
+    /**
+     * @inheritDoc
+     */
+    public static function from(array $attributes): static
+    {
+        if (!array_key_exists('tipo', $attributes) || $attributes['tipo'] !== 1) {
+            throw new BlingParseResponsePayloadException($attributes);
+        }
+
+        return parent::from($attributes);
+    }
+}
diff --git a/src/Entities/ContasPagar/Schema/Find/FindResponseData.php b/src/Entities/ContasPagar/Schema/Find/FindResponseData.php
@@ -5,6 +5,10 @@
 use AleBatistella\BlingErpApi\Entities\ContasPagar\Enum\Situacao;
 use AleBatistella\BlingErpApi\Entities\Shared\BaseResponseObject;
 use AleBatistella\BlingErpApi\Entities\Shared\DTO\Schema\Id;
+use AleBatistella\BlingErpApi\Entities\ContasPagar\Schema\Shared\ContasPagarOcorrenciaUnicaDTO as Unica;
+use AleBatistella\BlingErpApi\Entities\ContasPagar\Schema\Shared\ContasPagarOcorrenciaParceladaDTO as Parcelada;
+use AleBatistella\BlingErpApi\Entities\ContasPagar\Schema\Shared\ContasPagarOcorrenciaDTO as Normal;
+use AleBatistella\BlingErpApi\Entities\ContasPagar\Schema\Shared\ContasPagarOcorrenciaSemanalDTO as Semanal;
 
 readonly final class FindResponseData extends BaseResponseObject
 {
@@ -27,6 +31,7 @@
      * @param ?Id $portador
      * @param ?Id $categoria
      * @param int[] $borderos
+     * @param Unica|Parcelada|Normal|Semanal|null $ocorrencia
      */
     public function __construct(
         public ?int $id,
@@ -44,7 +49,7 @@ public function __construct(
         public string $numeroBanco,
         public ?Id $portador,
         public ?Id $categoria,
-        public array $borderos
-    ) {
-    }
+        public array $borderos,
+        public Unica|Parcelada|Normal|Semanal|null $ocorrencia,
+    ) {}
 }
diff --git a/src/Entities/ContasPagar/__tests__/find/response.json b/src/Entities/ContasPagar/__tests__/find/response.json
@@ -25,6 +25,9 @@
         },
         "borderos": [
             0
-        ]
+        ],
+        "ocorrencia": {
+            "tipo": 1
+        }
     }
 }
diff --git a/src/Entities/ContasReceber/Schema/Find/FindResponseData.php b/src/Entities/ContasReceber/Schema/Find/FindResponseData.php
@@ -27,7 +27,7 @@
      * @param ?FindResponseDataFormaPagamento $formaPagamento
      * @param ?FindResponseDataContaContabil $contaContabil
      * @param ?FindResponseDataOrigem $origem
-     * @param ?float $saldo
+     * @param float $saldo
      * @param string $vencimentoOriginal
      * @param ?string $numeroDocumento
      * @param ?string $competencia
@@ -62,6 +62,5 @@ public function __construct(
         public ?Id $vendedor,
         public array $borderos,
         public Unica|Parcelada|Normal|Semanal|null $ocorrencia,
-    ) {
-    }
+    ) {}
 }
diff --git a/src/Entities/FormasDePagamentos/Schema/Get/GetResponseData.php b/src/Entities/FormasDePagamentos/Schema/Get/GetResponseData.php
@@ -3,6 +3,7 @@
 namespace AleBatistella\BlingErpApi\Entities\FormasDePagamentos\Schema\Get;
 
 use AleBatistella\BlingErpApi\Entities\Shared\BaseResponseObject;
+use AleBatistella\BlingErpApi\Entities\FormasDePagamentos\Enum\Finalidade;
 use AleBatistella\BlingErpApi\Entities\FormasDePagamentos\Enum\Situacao;
 use AleBatistella\BlingErpApi\Entities\FormasDePagamentos\Enum\TipoPagamento;
 use AleBatistella\BlingErpApi\Entities\FormasDePagamentos\Enum\Padrao;
@@ -18,6 +19,7 @@
      * @param ?Situacao $situacao
      * @param ?bool $fixa
      * @param ?Padrao $padrao
+     * @param Finalidade $finalidade
      */
     public function __construct(
         public ?int $id,
@@ -26,6 +28,6 @@ public function __construct(
         public ?Situacao $situacao,
         public ?bool $fixa,
         public ?Padrao $padrao,
-    ) {
-    }
+        public Finalidade $finalidade
+    ) {}
 }
diff --git a/src/Entities/FormasDePagamentos/__tests__/get/response.json b/src/Entities/FormasDePagamentos/__tests__/get/response.json
@@ -6,7 +6,8 @@
       "tipoPagamento": 1,
       "situacao": 1,
       "fixa": false,
-      "padrao": 0
+      "padrao": 0,
+      "finalidade": 1
     }
   ]
 }
diff --git a/src/Entities/Produtos/Schema/Get/GetParams.php b/src/Entities/Produtos/Schema/Get/GetParams.php
@@ -54,10 +54,10 @@ public function __construct(
         $this->criterio =  $criterio instanceof Criterio ? $criterio->value : $criterio;
         $this->tipo =  $tipo instanceof TipoListagem ? $tipo->value : $tipo;
 
-        $this->dataInclusaoInicial = $this->prepareStringOrDateParam($dataInclusaoInicial);
-        $this->dataInclusaoFinal = $this->prepareStringOrDateParam($dataInclusaoFinal);
-        $this->dataAlteracaoInicial = $this->prepareStringOrDateParam($dataAlteracaoInicial);
-        $this->dataAlteracaoFinal = $this->prepareStringOrDateParam($dataAlteracaoFinal);
+        $this->dataInclusaoInicial = $this->prepareStringOrDateParam($dataInclusaoInicial, shouldIncludeTime: true);
+        $this->dataInclusaoFinal = $this->prepareStringOrDateParam($dataInclusaoFinal, shouldIncludeTime: true);
+        $this->dataAlteracaoInicial = $this->prepareStringOrDateParam($dataAlteracaoInicial, shouldIncludeTime: true);
+        $this->dataAlteracaoFinal = $this->prepareStringOrDateParam($dataAlteracaoFinal, shouldIncludeTime: true);
 
         parent::__construct(objectToArray($this));
     }

diff --git a/src/Helpers/functions.php b/src/Helpers/functions.php
@@ -14,6 +14,20 @@ function convertDateToString(\DateTimeInterface $date): string
   }
 }
 
+if (!function_exists('convertDateTimeToString')) {
+  /**
+   * Converte uma data para o formato YYYY-MM-DD HH:MM:SS.
+   *
+   * @param \DateTimeInterface $date
+   *
+   * @return string
+   */
+  function convertDateTimeToString(\DateTimeInterface $date): string
+  {
+    return $date->format('Y-m-d H:i:s');
+  }
+}
+
 if (!function_exists('fake')) {
   /**
    * Cria objeto para dados _fake_.