27582377165

Committed 15 Jun 2026 11:08PM UTC coverage: 4.589% (-0.04%) from 4.627%

Build # 27582377165

Build Type

push

github

Committed by

mathmarques

Commit Message

set min version to php 8.2

Coverage Stats

57 of 1242 relevant lines covered (4.59%)

0.05 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/Request/QueryPrePostagemRequest.php

<?php

namespace ChicoRei\Packages\Correios\Request;

use Carbon\Carbon;
use ChicoRei\Packages\Correios\CorreiosObject;

class QueryPrePostagemRequest extends CorreiosObject implements CorreiosRequest
{
    /**
     * ID da pré-postagem. Caso seja informado, apenas este parâmetro será considerado na consulta.
     */
    public ?string $id = null;

    /**
     * Código identificador do objeto. Caso seja informado e não seja informado Id,
     * apenas este parâmetro será considerado na consulta.
    */
    public ?string $codigoObjeto = null;

    /**
     * E-Ticket. Caso seja informado e não seja informado Id e Código de Objeto, apenas este parâmetro
     * será considerado na consulta.
    */
    public ?string $eTicket = null;

    /**
     * Código estampa 2D de objeto franqueado pela máquina. Caso seja informado e não seja informado Id,
     * Código de Objeto e E-ticket , apenas este parametro será considerado na consulta.
    */
    public ?string $codigoEstampa2D = null;

    /**
     * IdCorreios do cliente que gerou a pré-postagem à vista. Caso seja informado, é obrigatório informar Status.
     */
    public ?string $idCorreios = null;

    /**
     * Status da pré-postagem. Se não for informado parâmetro de Id/Código/Eticket, se torna obrigatório.
     * Available values : PREATENDIDO, PREPOSTADO, POSTADO, EXPIRADO, CANCELADO, ESTORNADO
    */
    public ?string $status = null;

    /**
     * Indicador de logística reversa. (S)=Sim, (N)=Não. Caso seja informado, é obrigatório informar status.
     */
    public ?string $logisticaReversa = null;

    /**
     * Tipo de objeto. Indica se a consulta deve retornar objetos Simples, Registrados ou Todos. Caso seja informado,
     * é obrigatório informar também outros parâmetros, como Status.
     * Available values : TODOS, SIMPLES, REGISTRADO
     */
    public ?string $tipoObjeto = null;

    /**
     * Modalidade Pagamento: A_VISTA, A_FATURAR, A_VISTA_FATURAR ou PRESTACAO_CONTAS_REC_PAG. Caso seja informado,
     * * é obrigatório informar também outros parâmetros, como status.
     */
    public ?string $modalidadePagamento = null;

    /**
     * Indicador de objeto Cargo. (S)=Sim, (N)=Não.
     */
    public ?string $objetoCargo = null;

    /**
     * Data Inicial da Pré-postagem no formato AAAA-MM-DD. Quando o status for PREPOSTADO ou PREATENDIDO,
     * não é necessário informar a data, apenas o status; Ao informar o código do objeto, não é necessário informar a
     * data, apenas o código; Quando informado, o filtro de data será sempre limitado a 30 dias; Para status
     * diferentes de PREPOSTADO ou PREATENDIDO, os campos de data são obrigatórios.
     */
    public ?Carbon $dataInicialCriacaoPrePostagem = null;

    /**
     * Data Final da Pré-postagem no formato AAAA-MM-DD. Quando o status for PREPOSTADO ou PREATENDIDO,
     * não é necessário informar a data, apenas o status; Ao informar o código do objeto, não é necessário informar a
     * data, apenas o código; Quando informado, o filtro de data será sempre limitado a 30 dias; Para status
     * diferentes de PREPOSTADO ou PREATENDIDO, os campos de data são obrigatórios.
     */
    public ?Carbon $dataFinalCriacaoPrePostagem = null;

    /**
     * Número da página
     */
    public ?string $page = null;

    /**
     * Tamanho da página
     */
    public ?string $size = null;

    public function getId(): ?string
    {
        return $this->id;
    }

    public function setId(?string $id): QueryPrePostagemRequest
    {
        $this->id = $id;
        return $this;
    }

    public function getCodigoObjeto(): ?string
    {
        return $this->codigoObjeto;
    }

    public function setCodigoObjeto(?string $codigoObjeto): QueryPrePostagemRequest
    {
        $this->codigoObjeto = $codigoObjeto;
        return $this;
    }

    public function getETicket(): ?string
    {
        return $this->eTicket;
    }

    public function setETicket(?string $eTicket): QueryPrePostagemRequest
    {
        $this->eTicket = $eTicket;
        return $this;
    }

    public function getCodigoEstampa2D(): ?string
    {
        return $this->codigoEstampa2D;
    }

    public function setCodigoEstampa2D(?string $codigoEstampa2D): QueryPrePostagemRequest
    {
        $this->codigoEstampa2D = $codigoEstampa2D;
        return $this;
    }

    public function getIdCorreios(): ?string
    {
        return $this->idCorreios;
    }

    public function setIdCorreios(?string $idCorreios): QueryPrePostagemRequest
    {
        $this->idCorreios = $idCorreios;
        return $this;
    }

    public function getStatus(): ?string
    {
        return $this->status;
    }

    public function setStatus(?string $status): QueryPrePostagemRequest
    {
        $this->status = $status;
        return $this;
    }

    public function getLogisticaReversa(): ?string
    {
        return $this->logisticaReversa;
    }

    public function setLogisticaReversa(?string $logisticaReversa): QueryPrePostagemRequest
    {
        $this->logisticaReversa = $logisticaReversa;
        return $this;
    }

    public function getTipoObjeto(): ?string
    {
        return $this->tipoObjeto;
    }

    public function setTipoObjeto(?string $tipoObjeto): QueryPrePostagemRequest
    {
        $this->tipoObjeto = $tipoObjeto;
        return $this;
    }

    public function getModalidadePagamento(): ?string
    {
        return $this->modalidadePagamento;
    }

    public function setModalidadePagamento(?string $modalidadePagamento): QueryPrePostagemRequest
    {
        $this->modalidadePagamento = $modalidadePagamento;
        return $this;
    }

    public function getObjetoCargo(): ?string
    {
        return $this->objetoCargo;
    }

    public function setObjetoCargo(?string $objetoCargo): QueryPrePostagemRequest
    {
        $this->objetoCargo = $objetoCargo;
        return $this;
    }

    public function getDataInicialCriacaoPrePostagem(): ?Carbon
    {
        return $this->dataInicialCriacaoPrePostagem;
    }

    public function setDataInicialCriacaoPrePostagem(?Carbon $dataInicialCriacaoPrePostagem): QueryPrePostagemRequest
    {
        $this->dataInicialCriacaoPrePostagem = $dataInicialCriacaoPrePostagem;
        return $this;
    }

    public function getDataFinalCriacaoPrePostagem(): ?Carbon
    {
        return $this->dataFinalCriacaoPrePostagem;
    }

    public function setDataFinalCriacaoPrePostagem(?Carbon $dataFinalCriacaoPrePostagem): QueryPrePostagemRequest
    {
        $this->dataFinalCriacaoPrePostagem = $dataFinalCriacaoPrePostagem;
        return $this;
    }

    public function getPage(): ?string
    {
        return $this->page;
    }

    public function setPage(?string $page): QueryPrePostagemRequest
    {
        $this->page = $page;
        return $this;
    }

    public function getSize(): ?string
    {
        return $this->size;
    }

    public function setSize(?string $size): QueryPrePostagemRequest
    {
        $this->size = $size;
        return $this;
    }

    public function getMethod(): string
    {
        return 'GET';
    }

    public function getPath(): string
    {
        return '/prepostagem/v2/prepostagens';
    }

    public function getPayload(): ?array
    {
        return null;
    }

    public function getQuery(): ?array
    {
        return $this->toArray();
    }

    public function toArray(): array
    {
        return [
            'id' => $this->getId(),
            'codigoObjeto' => $this->getCodigoObjeto(),
            'eTicket' => $this->getETicket(),
            'codigoEstampa2D' => $this->getCodigoEstampa2D(),
            'idCorreios' => $this->getIdCorreios(),
            'status' => $this->getStatus(),
            'logisticaReversa' => $this->getLogisticaReversa(),
            'tipoObjeto' => $this->getTipoObjeto(),
            'modalidadePagamento' => $this->getModalidadePagamento(),
            'objetoCargo' => $this->getObjetoCargo(),
            'dataInicialCriacaoPrePostagem' => $this->getDataInicialCriacaoPrePostagem()
                ? $this->getDataInicialCriacaoPrePostagem()->format('Y-m-d')
                : null,
            'dataFinalCriacaoPrePostagem' => $this->getDataFinalCriacaoPrePostagem()
                ? $this->getDataFinalCriacaoPrePostagem()->format('Y-m-d')
                : null,
            'page' => $this->getPage(),
            'size' => $this->getSize(),
        ];
    }
}

1	<?php
2
3	namespace ChicoRei\Packages\Correios\Request;
4
5	use Carbon\Carbon;
6	use ChicoRei\Packages\Correios\CorreiosObject;
7
8	class QueryPrePostagemRequest extends CorreiosObject implements CorreiosRequest
9	{
10	/**
11	* ID da pré-postagem. Caso seja informado, apenas este parâmetro será considerado na consulta.
12	*/
13	public ?string $id = null;
14
15	/**
16	* Código identificador do objeto. Caso seja informado e não seja informado Id,
17	* apenas este parâmetro será considerado na consulta.
18	*/
19	public ?string $codigoObjeto = null;
20
21	/**
22	* E-Ticket. Caso seja informado e não seja informado Id e Código de Objeto, apenas este parâmetro
23	* será considerado na consulta.
24	*/
25	public ?string $eTicket = null;
26
27	/**
28	* Código estampa 2D de objeto franqueado pela máquina. Caso seja informado e não seja informado Id,
29	* Código de Objeto e E-ticket , apenas este parametro será considerado na consulta.
30	*/
31	public ?string $codigoEstampa2D = null;
32
33	/**
34	* IdCorreios do cliente que gerou a pré-postagem à vista. Caso seja informado, é obrigatório informar Status.
35	*/
36	public ?string $idCorreios = null;
37
38	/**
39	* Status da pré-postagem. Se não for informado parâmetro de Id/Código/Eticket, se torna obrigatório.
40	* Available values : PREATENDIDO, PREPOSTADO, POSTADO, EXPIRADO, CANCELADO, ESTORNADO
41	*/
42	public ?string $status = null;
43
44	/**
45	* Indicador de logística reversa. (S)=Sim, (N)=Não. Caso seja informado, é obrigatório informar status.
46	*/
47	public ?string $logisticaReversa = null;
48
49	/**
50	* Tipo de objeto. Indica se a consulta deve retornar objetos Simples, Registrados ou Todos. Caso seja informado,
51	* é obrigatório informar também outros parâmetros, como Status.
52	* Available values : TODOS, SIMPLES, REGISTRADO
53	*/
54	public ?string $tipoObjeto = null;
55
56	/**
57	* Modalidade Pagamento: A_VISTA, A_FATURAR, A_VISTA_FATURAR ou PRESTACAO_CONTAS_REC_PAG. Caso seja informado,
58	* * é obrigatório informar também outros parâmetros, como status.
59	*/
60	public ?string $modalidadePagamento = null;
61
62	/**
63	* Indicador de objeto Cargo. (S)=Sim, (N)=Não.
64	*/
65	public ?string $objetoCargo = null;
66
67	/**
68	* Data Inicial da Pré-postagem no formato AAAA-MM-DD. Quando o status for PREPOSTADO ou PREATENDIDO,
69	* não é necessário informar a data, apenas o status; Ao informar o código do objeto, não é necessário informar a
70	* data, apenas o código; Quando informado, o filtro de data será sempre limitado a 30 dias; Para status
71	* diferentes de PREPOSTADO ou PREATENDIDO, os campos de data são obrigatórios.
72	*/
73	public ?Carbon $dataInicialCriacaoPrePostagem = null;
74
75	/**
76	* Data Final da Pré-postagem no formato AAAA-MM-DD. Quando o status for PREPOSTADO ou PREATENDIDO,
77	* não é necessário informar a data, apenas o status; Ao informar o código do objeto, não é necessário informar a
78	* data, apenas o código; Quando informado, o filtro de data será sempre limitado a 30 dias; Para status
79	* diferentes de PREPOSTADO ou PREATENDIDO, os campos de data são obrigatórios.
80	*/
81	public ?Carbon $dataFinalCriacaoPrePostagem = null;
82
83	/**
84	* Número da página
85	*/
86	public ?string $page = null;
87
88	/**
89	* Tamanho da página
90	*/
91	public ?string $size = null;
92
93	public function getId(): ?string
94	{
95	return $this->id;	×
96	}
97
98	public function setId(?string $id): QueryPrePostagemRequest
99	{
100	$this->id = $id;	×
101	return $this;	×
102	}
103
104	public function getCodigoObjeto(): ?string
105	{
106	return $this->codigoObjeto;	×
107	}
108
109	public function setCodigoObjeto(?string $codigoObjeto): QueryPrePostagemRequest
110	{
111	$this->codigoObjeto = $codigoObjeto;	×
112	return $this;	×
113	}
114
115	public function getETicket(): ?string
116	{
117	return $this->eTicket;	×
118	}
119
120	public function setETicket(?string $eTicket): QueryPrePostagemRequest
121	{
122	$this->eTicket = $eTicket;	×
123	return $this;	×
124	}
125
126	public function getCodigoEstampa2D(): ?string
127	{
128	return $this->codigoEstampa2D;	×
129	}
130
131	public function setCodigoEstampa2D(?string $codigoEstampa2D): QueryPrePostagemRequest
132	{
133	$this->codigoEstampa2D = $codigoEstampa2D;	×
134	return $this;	×
135	}
136
137	public function getIdCorreios(): ?string
138	{
139	return $this->idCorreios;	×
140	}
141
142	public function setIdCorreios(?string $idCorreios): QueryPrePostagemRequest
143	{
144	$this->idCorreios = $idCorreios;	×
145	return $this;	×
146	}
147
148	public function getStatus(): ?string
149	{
150	return $this->status;	×
151	}
152
153	public function setStatus(?string $status): QueryPrePostagemRequest
154	{
155	$this->status = $status;	×
156	return $this;	×
157	}
158
159	public function getLogisticaReversa(): ?string
160	{
161	return $this->logisticaReversa;	×
162	}
163
164	public function setLogisticaReversa(?string $logisticaReversa): QueryPrePostagemRequest
165	{
166	$this->logisticaReversa = $logisticaReversa;	×
167	return $this;	×
168	}
169
170	public function getTipoObjeto(): ?string
171	{
172	return $this->tipoObjeto;	×
173	}
174
175	public function setTipoObjeto(?string $tipoObjeto): QueryPrePostagemRequest
176	{
177	$this->tipoObjeto = $tipoObjeto;	×
178	return $this;	×
179	}
180
181	public function getModalidadePagamento(): ?string
182	{
183	return $this->modalidadePagamento;	×
184	}
185
186	public function setModalidadePagamento(?string $modalidadePagamento): QueryPrePostagemRequest
187	{
188	$this->modalidadePagamento = $modalidadePagamento;	×
189	return $this;	×
190	}
191
192	public function getObjetoCargo(): ?string
193	{
194	return $this->objetoCargo;	×
195	}
196
197	public function setObjetoCargo(?string $objetoCargo): QueryPrePostagemRequest
198	{
199	$this->objetoCargo = $objetoCargo;	×
200	return $this;	×
201	}
202
203	public function getDataInicialCriacaoPrePostagem(): ?Carbon
204	{
205	return $this->dataInicialCriacaoPrePostagem;	×
206	}
207
208	public function setDataInicialCriacaoPrePostagem(?Carbon $dataInicialCriacaoPrePostagem): QueryPrePostagemRequest
209	{
210	$this->dataInicialCriacaoPrePostagem = $dataInicialCriacaoPrePostagem;	×
211	return $this;	×
212	}
213
214	public function getDataFinalCriacaoPrePostagem(): ?Carbon
215	{
216	return $this->dataFinalCriacaoPrePostagem;	×
217	}
218
219	public function setDataFinalCriacaoPrePostagem(?Carbon $dataFinalCriacaoPrePostagem): QueryPrePostagemRequest
220	{
221	$this->dataFinalCriacaoPrePostagem = $dataFinalCriacaoPrePostagem;	×
222	return $this;	×
223	}
224
225	public function getPage(): ?string
226	{
227	return $this->page;	×
228	}
229
230	public function setPage(?string $page): QueryPrePostagemRequest
231	{
232	$this->page = $page;	×
233	return $this;	×
234	}
235
236	public function getSize(): ?string
237	{
238	return $this->size;	×
239	}
240
241	public function setSize(?string $size): QueryPrePostagemRequest
242	{
243	$this->size = $size;	×
244	return $this;	×
245	}
246
247	public function getMethod(): string
248	{
249	return 'GET';	×
250	}
251
252	public function getPath(): string
253	{
254	return '/prepostagem/v2/prepostagens';	×
255	}
256
257	public function getPayload(): ?array
258	{
259	return null;	×
260	}
261
262	public function getQuery(): ?array
263	{
264	return $this->toArray();	×
265	}
266
267	public function toArray(): array
268	{
269	return [	×
270	'id' => $this->getId(),	×
271	'codigoObjeto' => $this->getCodigoObjeto(),	×
272	'eTicket' => $this->getETicket(),	×
273	'codigoEstampa2D' => $this->getCodigoEstampa2D(),	×
274	'idCorreios' => $this->getIdCorreios(),	×
275	'status' => $this->getStatus(),	×
276	'logisticaReversa' => $this->getLogisticaReversa(),	×
277	'tipoObjeto' => $this->getTipoObjeto(),	×
278	'modalidadePagamento' => $this->getModalidadePagamento(),	×
279	'objetoCargo' => $this->getObjetoCargo(),	×
280	'dataInicialCriacaoPrePostagem' => $this->getDataInicialCriacaoPrePostagem()	×
281	? $this->getDataInicialCriacaoPrePostagem()->format('Y-m-d')	×
282	: null,	×
283	'dataFinalCriacaoPrePostagem' => $this->getDataFinalCriacaoPrePostagem()	×
284	? $this->getDataFinalCriacaoPrePostagem()->format('Y-m-d')	×
285	: null,	×
286	'page' => $this->getPage(),	×
287	'size' => $this->getSize(),	×
288	];	×
289	}
290	}

chico-rei / correios-php / 27582377165

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous