Skip to content

Commit afff971

Browse files
author
Rodion Liuborets
committed
Add comments to DocScanClient
1 parent 19410be commit afff971

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/DocScan/DocScanClient.php

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,8 @@ public function deleteMediaContent(string $sessionId, string $mediaId): void
129129
}
130130

131131
/**
132+
* Gets a list of supported documents.
133+
*
132134
* @param bool $isStrictlyLatin
133135
* @return SupportedDocumentsResponse
134136
* @throws Exception\DocScanException
@@ -139,6 +141,9 @@ public function getSupportedDocuments(bool $isStrictlyLatin = false): SupportedD
139141
}
140142

141143
/**
144+
* Creates a Face Capture resource, that will be linked using
145+
* the supplied requirement ID
146+
*
142147
* @param string $sessionId
143148
* @param CreateFaceCaptureResourcePayload $createFaceCaptureResourcePayload
144149
* @return Session\Retrieve\CreateFaceCaptureResourceResponse
@@ -152,6 +157,8 @@ public function createFaceCaptureResource(
152157
}
153158

154159
/**
160+
* Uploads an image to the specified Face Capture resource
161+
*
155162
* @param string $sessionId
156163
* @param string $resourceId
157164
* @param UploadFaceCaptureImagePayload $uploadFaceCaptureImagePayload
@@ -178,6 +185,8 @@ public function getSessionConfiguration(string $sessionId): SessionConfiguration
178185
}
179186

180187
/**
188+
* Sets the IBV instructions for the given session
189+
*
181190
* @throws Exception\DocScanException
182191
*/
183192
public function putIbvInstructions(string $sessionId, Instructions $instructions): void

0 commit comments

Comments
 (0)