Skip to content
This repository was archived by the owner on Apr 29, 2019. It is now read-only.

Commit 2d475f2

Browse files
author
Oleksii Korshenko
committed
MAGETWO-71174: Update doc block information in php classes with @deprecated and @SInCE tags
- replaced release version with package version in @SInCE and @depreacated tags - removed @SInCE tag from private properties/methods and non @api classes
1 parent d90957d commit 2d475f2

File tree

75 files changed

+51
-470
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+51
-470
lines changed

Api/CaseCreationServiceInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
* Implementation should send request to Signifyd API and create new entity in Magento.
1313
*
1414
* @api
15-
* @since 2.2.0
15+
* @since 100.2.0
1616
*/
1717
interface CaseCreationServiceInterface
1818
{
@@ -23,7 +23,7 @@ interface CaseCreationServiceInterface
2323
* @return bool
2424
* @throws \Magento\Framework\Exception\NotFoundException If order does not exists
2525
* @throws \Magento\Framework\Exception\AlreadyExistsException If case for $orderId already exists
26-
* @since 2.2.0
26+
* @since 100.2.0
2727
*/
2828
public function createForOrder($orderId);
2929
}

Api/CaseManagementInterface.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* Allows to performs operations with Signifyd cases.
1111
*
1212
* @api
13-
* @since 2.2.0
13+
* @since 100.2.0
1414
*/
1515
interface CaseManagementInterface
1616
{
@@ -21,7 +21,7 @@ interface CaseManagementInterface
2121
* @return \Magento\Signifyd\Api\Data\CaseInterface
2222
* @throws \Magento\Framework\Exception\NotFoundException If order does not exists
2323
* @throws \Magento\Framework\Exception\AlreadyExistsException If case for $orderId already exists
24-
* @since 2.2.0
24+
* @since 100.2.0
2525
*/
2626
public function create($orderId);
2727

@@ -30,7 +30,7 @@ public function create($orderId);
3030
*
3131
* @param int $orderId
3232
* @return \Magento\Signifyd\Api\Data\CaseInterface|null
33-
* @since 2.2.0
33+
* @since 100.2.0
3434
*/
3535
public function getByOrderId($orderId);
3636
}

Api/CaseRepositoryInterface.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* Signifyd Case repository interface
1010
*
1111
* @api
12-
* @since 2.2.0
12+
* @since 100.2.0
1313
*/
1414
interface CaseRepositoryInterface
1515
{
@@ -18,7 +18,7 @@ interface CaseRepositoryInterface
1818
*
1919
* @param \Magento\Signifyd\Api\Data\CaseInterface $case
2020
* @return \Magento\Signifyd\Api\Data\CaseInterface
21-
* @since 2.2.0
21+
* @since 100.2.0
2222
*/
2323
public function save(\Magento\Signifyd\Api\Data\CaseInterface $case);
2424

@@ -27,7 +27,7 @@ public function save(\Magento\Signifyd\Api\Data\CaseInterface $case);
2727
*
2828
* @param int $id
2929
* @return \Magento\Signifyd\Api\Data\CaseInterface
30-
* @since 2.2.0
30+
* @since 100.2.0
3131
*/
3232
public function getById($id);
3333

@@ -36,7 +36,7 @@ public function getById($id);
3636
*
3737
* @param int $caseId
3838
* @return \Magento\Signifyd\Api\Data\CaseInterface|null
39-
* @since 2.2.0
39+
* @since 100.2.0
4040
*/
4141
public function getByCaseId($caseId);
4242

@@ -45,7 +45,7 @@ public function getByCaseId($caseId);
4545
*
4646
* @param \Magento\Signifyd\Api\Data\CaseInterface $case
4747
* @return bool
48-
* @since 2.2.0
48+
* @since 100.2.0
4949
*/
5050
public function delete(\Magento\Signifyd\Api\Data\CaseInterface $case);
5151

@@ -54,7 +54,7 @@ public function delete(\Magento\Signifyd\Api\Data\CaseInterface $case);
5454
*
5555
* @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
5656
* @return \Magento\Signifyd\Api\Data\CaseSearchResultsInterface
57-
* @since 2.2.0
57+
* @since 100.2.0
5858
*/
5959
public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);
6060
}

Api/Data/CaseInterface.php

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
*
1313
* @api
1414
* @see https://www.signifyd.com/docs/api/#/reference/cases/retrieve-a-case/get-a-case
15-
* @since 2.2.0
15+
* @since 100.2.0
1616
*/
1717
interface CaseInterface
1818
{
@@ -49,7 +49,7 @@ interface CaseInterface
4949
* Returns local case entity identifier.
5050
*
5151
* @return int
52-
* @since 2.2.0
52+
* @since 100.2.0
5353
*/
5454
public function getEntityId();
5555

@@ -58,15 +58,15 @@ public function getEntityId();
5858
*
5959
* @param int $id
6060
* @return $this
61-
* @since 2.2.0
61+
* @since 100.2.0
6262
*/
6363
public function setEntityId($id);
6464

6565
/**
6666
* Returns Signifyd case identifier.
6767
*
6868
* @return int
69-
* @since 2.2.0
69+
* @since 100.2.0
7070
*/
7171
public function getCaseId();
7272

@@ -75,7 +75,7 @@ public function getCaseId();
7575
*
7676
* @param int $id
7777
* @return $this
78-
* @since 2.2.0
78+
* @since 100.2.0
7979
*/
8080
public function setCaseId($id);
8181

@@ -84,7 +84,7 @@ public function setCaseId($id);
8484
* Returns null if state of guarantee eligible does not set yet.
8585
*
8686
* @return boolean|null
87-
* @since 2.2.0
87+
* @since 100.2.0
8888
*/
8989
public function isGuaranteeEligible();
9090

@@ -93,15 +93,15 @@ public function isGuaranteeEligible();
9393
*
9494
* @param bool $guaranteeEligible
9595
* @return $this
96-
* @since 2.2.0
96+
* @since 100.2.0
9797
*/
9898
public function setGuaranteeEligible($guaranteeEligible);
9999

100100
/**
101101
* Returns decision state of the guarantee.
102102
*
103103
* @return string
104-
* @since 2.2.0
104+
* @since 100.2.0
105105
*/
106106
public function getGuaranteeDisposition();
107107

@@ -110,15 +110,15 @@ public function getGuaranteeDisposition();
110110
*
111111
* @param string $disposition
112112
* @return $this
113-
* @since 2.2.0
113+
* @since 100.2.0
114114
*/
115115
public function setGuaranteeDisposition($disposition);
116116

117117
/**
118118
* Returns case status.
119119
*
120120
* @return string
121-
* @since 2.2.0
121+
* @since 100.2.0
122122
*/
123123
public function getStatus();
124124

@@ -127,15 +127,15 @@ public function getStatus();
127127
*
128128
* @param string $status
129129
* @return $this
130-
* @since 2.2.0
130+
* @since 100.2.0
131131
*/
132132
public function setStatus($status);
133133

134134
/**
135135
* Returns value, which indicates the likelihood that the order is fraud.
136136
*
137137
* @return int
138-
* @since 2.2.0
138+
* @since 100.2.0
139139
*/
140140
public function getScore();
141141

@@ -144,15 +144,15 @@ public function getScore();
144144
*
145145
* @param int $score
146146
* @return $this
147-
* @since 2.2.0
147+
* @since 100.2.0
148148
*/
149149
public function setScore($score);
150150

151151
/**
152152
* Get order id for a case.
153153
*
154154
* @return int
155-
* @since 2.2.0
155+
* @since 100.2.0
156156
*/
157157
public function getOrderId();
158158

@@ -161,15 +161,15 @@ public function getOrderId();
161161
*
162162
* @param int $orderId
163163
* @return $this
164-
* @since 2.2.0
164+
* @since 100.2.0
165165
*/
166166
public function setOrderId($orderId);
167167

168168
/**
169169
* Returns data about a team associated with a case.
170170
*
171171
* @return array
172-
* @since 2.2.0
172+
* @since 100.2.0
173173
*/
174174
public function getAssociatedTeam();
175175

@@ -178,15 +178,15 @@ public function getAssociatedTeam();
178178
*
179179
* @param array $team
180180
* @return $this
181-
* @since 2.2.0
181+
* @since 100.2.0
182182
*/
183183
public function setAssociatedTeam(array $team);
184184

185185
/**
186186
* Returns disposition of an agent's opinion after reviewing the case.
187187
*
188188
* @return string
189-
* @since 2.2.0
189+
* @since 100.2.0
190190
*/
191191
public function getReviewDisposition();
192192

@@ -195,15 +195,15 @@ public function getReviewDisposition();
195195
*
196196
* @param string $disposition
197197
* @return $this
198-
* @since 2.2.0
198+
* @since 100.2.0
199199
*/
200200
public function setReviewDisposition($disposition);
201201

202202
/**
203203
* Returns creation datetime for a case.
204204
*
205205
* @return string
206-
* @since 2.2.0
206+
* @since 100.2.0
207207
*/
208208
public function getCreatedAt();
209209

@@ -212,15 +212,15 @@ public function getCreatedAt();
212212
*
213213
* @param string $datetime in DATE_ATOM format
214214
* @return $this
215-
* @since 2.2.0
215+
* @since 100.2.0
216216
*/
217217
public function setCreatedAt($datetime);
218218

219219
/**
220220
* Returns updating datetime for a case.
221221
*
222222
* @return string
223-
* @since 2.2.0
223+
* @since 100.2.0
224224
*/
225225
public function getUpdatedAt();
226226

@@ -229,7 +229,7 @@ public function getUpdatedAt();
229229
*
230230
* @param string $datetime in DATE_ATOM format
231231
* @return $this
232-
* @since 2.2.0
232+
* @since 100.2.0
233233
*/
234234
public function setUpdatedAt($datetime);
235235
}

Api/Data/CaseSearchResultsInterface.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@
1111
* Retrieve and set list of case entities.
1212
*
1313
* @api
14-
* @since 2.2.0
14+
* @since 100.2.0
1515
*/
1616
interface CaseSearchResultsInterface extends SearchResultsInterface
1717
{
1818
/**
1919
* Gets collection of case entities.
2020
*
2121
* @return \Magento\Signifyd\Api\Data\CaseInterface[]
22-
* @since 2.2.0
22+
* @since 100.2.0
2323
*/
2424
public function getItems();
2525

@@ -28,7 +28,7 @@ public function getItems();
2828
*
2929
* @param \Magento\Signifyd\Api\Data\CaseInterface[] $items
3030
* @return $this
31-
* @since 2.2.0
31+
* @since 100.2.0
3232
*/
3333
public function setItems(array $items);
3434
}

Api/GuaranteeCancelingServiceInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
* Implementation should send request to Signifyd API and update existing case entity with guarantee information.
1313
*
1414
* @api
15-
* @since 2.2.0
15+
* @since 100.2.0
1616
*/
1717
interface GuaranteeCancelingServiceInterface
1818
{
@@ -21,7 +21,7 @@ interface GuaranteeCancelingServiceInterface
2121
*
2222
* @param int $orderId
2323
* @return bool
24-
* @since 2.2.0
24+
* @since 100.2.0
2525
*/
2626
public function cancelForOrder($orderId);
2727
}

Api/GuaranteeCreationServiceInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
* Implementation should send request to Signifyd API and update existing case entity with guarantee infromation.
1313
*
1414
* @api
15-
* @since 2.2.0
15+
* @since 100.2.0
1616
*/
1717
interface GuaranteeCreationServiceInterface
1818
{
@@ -21,7 +21,7 @@ interface GuaranteeCreationServiceInterface
2121
*
2222
* @param int $orderId
2323
* @return bool
24-
* @since 2.2.0
24+
* @since 100.2.0
2525
*/
2626
public function createForOrder($orderId);
2727
}

0 commit comments

Comments
 (0)