diff --git a/.github/workflows/_publish-guide.yml b/.github/workflows/_publish-guide.yml index b0c2b825..27f801a2 100644 --- a/.github/workflows/_publish-guide.yml +++ b/.github/workflows/_publish-guide.yml @@ -1,4 +1,4 @@ -name: Publish Guide to readme.com +name: Publish Guide on: workflow_call: diff --git a/docs/code_samples/us_mail_v2_async.txt b/docs/code_samples/us_mail_v2_async.txt deleted file mode 100644 index 54143ec6..00000000 --- a/docs/code_samples/us_mail_v2_async.txt +++ /dev/null @@ -1,15 +0,0 @@ -sourceFromPath("/path/to/the/file.ext"); - -// Parse the file asynchronously -$apiResponse = $mindeeClient->enqueueAndParse(UsMailV2::class, $inputSource); - -echo $apiResponse->document; \ No newline at end of file diff --git a/src/Product/Us/UsMail/UsMailV2.php b/src/Product/Us/UsMail/UsMailV2.php deleted file mode 100644 index 69435192..00000000 --- a/src/Product/Us/UsMail/UsMailV2.php +++ /dev/null @@ -1,40 +0,0 @@ -prediction = new UsMailV2Document($rawPrediction['prediction']); - $this->pages = []; - foreach ($rawPrediction['pages'] as $page) { - try { - $this->pages[] = new Page(UsMailV2Document::class, $page); - } catch (MindeeUnsetException $ignored) { - } - } - } -} diff --git a/src/Product/Us/UsMail/UsMailV2Document.php b/src/Product/Us/UsMail/UsMailV2Document.php deleted file mode 100644 index 18f70779..00000000 --- a/src/Product/Us/UsMail/UsMailV2Document.php +++ /dev/null @@ -1,87 +0,0 @@ -recipientAddresses = new UsMailV2RecipientAddresses( - $rawPrediction["recipient_addresses"], - $pageId - ); - if (!isset($rawPrediction["recipient_names"])) { - throw new MindeeUnsetException(); - } - $this->recipientNames = $rawPrediction["recipient_names"] == null ? [] : array_map( - fn ($prediction) => new StringField($prediction, $pageId), - $rawPrediction["recipient_names"] - ); - if (!isset($rawPrediction["sender_address"])) { - throw new MindeeUnsetException(); - } - $this->senderAddress = new UsMailV2SenderAddress( - $rawPrediction["sender_address"], - $pageId - ); - if (!isset($rawPrediction["sender_name"])) { - throw new MindeeUnsetException(); - } - $this->senderName = new StringField( - $rawPrediction["sender_name"], - $pageId - ); - } - - /** - * @return string String representation. - */ - public function __toString(): string - { - $senderAddressToFieldList = $this->senderAddress != null ? $this->senderAddress->toFieldList() : ""; - $recipientNames = implode( - "\n ", - $this->recipientNames - ); - $recipientAddressesSummary = strval($this->recipientAddresses); - - $outStr = ":Sender Name: $this->senderName -:Sender Address: $senderAddressToFieldList -:Recipient Names: $recipientNames -:Recipient Addresses: $recipientAddressesSummary -"; - return SummaryHelper::cleanOutString($outStr); - } -} diff --git a/src/Product/Us/UsMail/UsMailV2RecipientAddress.php b/src/Product/Us/UsMail/UsMailV2RecipientAddress.php deleted file mode 100644 index 214456a8..00000000 --- a/src/Product/Us/UsMail/UsMailV2RecipientAddress.php +++ /dev/null @@ -1,124 +0,0 @@ -setConfidence($rawPrediction); - $this->setPosition($rawPrediction); - $this->city = $rawPrediction["city"] ?? null; - $this->complete = $rawPrediction["complete"] ?? null; - $this->isAddressChange = $rawPrediction["is_address_change"] ?? null; - $this->postalCode = $rawPrediction["postal_code"] ?? null; - $this->privateMailboxNumber = $rawPrediction["private_mailbox_number"] ?? null; - $this->state = $rawPrediction["state"] ?? null; - $this->street = $rawPrediction["street"] ?? null; - } - - /** - * Return values for printing inside an RST table. - * - * @return array - */ - private function tablePrintableValues(): array - { - $outArr = []; - $outArr["city"] = SummaryHelper::formatForDisplay($this->city, 15); - $outArr["complete"] = SummaryHelper::formatForDisplay($this->complete, 35); - $outArr["isAddressChange"] = SummaryHelper::formatForDisplay($this->isAddressChange); - $outArr["postalCode"] = SummaryHelper::formatForDisplay($this->postalCode); - $outArr["privateMailboxNumber"] = SummaryHelper::formatForDisplay($this->privateMailboxNumber); - $outArr["state"] = SummaryHelper::formatForDisplay($this->state); - $outArr["street"] = SummaryHelper::formatForDisplay($this->street, 25); - return $outArr; - } - - /** - * Return values for printing as an array. - * - * @return array - */ - private function printableValues(): array - { - $outArr = []; - $outArr["city"] = SummaryHelper::formatForDisplay($this->city); - $outArr["complete"] = SummaryHelper::formatForDisplay($this->complete); - $outArr["isAddressChange"] = SummaryHelper::formatForDisplay($this->isAddressChange); - $outArr["postalCode"] = SummaryHelper::formatForDisplay($this->postalCode); - $outArr["privateMailboxNumber"] = SummaryHelper::formatForDisplay($this->privateMailboxNumber); - $outArr["state"] = SummaryHelper::formatForDisplay($this->state); - $outArr["street"] = SummaryHelper::formatForDisplay($this->street); - return $outArr; - } - /** - * Output in a format suitable for inclusion in an rST table. - * - * @return string - */ - public function toTableLine(): string - { - $printable = $this->tablePrintableValues(); - $outStr = "| "; - $outStr .= SummaryHelper::padString($printable["city"], 15); - $outStr .= SummaryHelper::padString($printable["complete"], 35); - $outStr .= SummaryHelper::padString($printable["isAddressChange"], 17); - $outStr .= SummaryHelper::padString($printable["postalCode"], 11); - $outStr .= SummaryHelper::padString($printable["privateMailboxNumber"], 22); - $outStr .= SummaryHelper::padString($printable["state"], 5); - $outStr .= SummaryHelper::padString($printable["street"], 25); - return rtrim(SummaryHelper::cleanOutString($outStr)); - } - - /** - * @return string String representation. - */ - public function __toString(): string - { - return SummaryHelper::cleanOutString($this->toTableLine()); - } -} diff --git a/src/Product/Us/UsMail/UsMailV2RecipientAddresses.php b/src/Product/Us/UsMail/UsMailV2RecipientAddresses.php deleted file mode 100644 index 35cfe912..00000000 --- a/src/Product/Us/UsMail/UsMailV2RecipientAddresses.php +++ /dev/null @@ -1,72 +0,0 @@ -getIterator(); - if (!$iterator->valid()) { - return ""; - } - while ($iterator->valid()) { - $entry = $iterator->current(); - $lines .= "\n " . $entry->toTableLine() . "\n" . self::recipientAddressesSeparator('-'); - $iterator->next(); - } - $outStr = "\n" . self::recipientAddressesSeparator('-') . "\n "; - $outStr .= " | City "; - $outStr .= " | Complete Address "; - $outStr .= " | Is Address Change"; - $outStr .= " | Postal Code"; - $outStr .= " | Private Mailbox Number"; - $outStr .= " | State"; - $outStr .= " | Street "; - $outStr .= " |\n" . self::recipientAddressesSeparator('='); - $outStr .= $lines; - return $outStr; - } -} diff --git a/src/Product/Us/UsMail/UsMailV2SenderAddress.php b/src/Product/Us/UsMail/UsMailV2SenderAddress.php deleted file mode 100644 index ec27ed18..00000000 --- a/src/Product/Us/UsMail/UsMailV2SenderAddress.php +++ /dev/null @@ -1,108 +0,0 @@ -setConfidence($rawPrediction); - $this->setPosition($rawPrediction); - $this->city = $rawPrediction["city"] ?? null; - $this->complete = $rawPrediction["complete"] ?? null; - $this->postalCode = $rawPrediction["postal_code"] ?? null; - $this->state = $rawPrediction["state"] ?? null; - $this->street = $rawPrediction["street"] ?? null; - } - - /** - * Return values for printing inside an RST table. - * - * @return array - */ - private function tablePrintableValues(): array - { - $outArr = []; - $outArr["city"] = SummaryHelper::formatForDisplay($this->city, 15); - $outArr["complete"] = SummaryHelper::formatForDisplay($this->complete, 35); - $outArr["postalCode"] = SummaryHelper::formatForDisplay($this->postalCode); - $outArr["state"] = SummaryHelper::formatForDisplay($this->state); - $outArr["street"] = SummaryHelper::formatForDisplay($this->street, 25); - return $outArr; - } - - /** - * Return values for printing as an array. - * - * @return array - */ - private function printableValues(): array - { - $outArr = []; - $outArr["city"] = SummaryHelper::formatForDisplay($this->city); - $outArr["complete"] = SummaryHelper::formatForDisplay($this->complete); - $outArr["postalCode"] = SummaryHelper::formatForDisplay($this->postalCode); - $outArr["state"] = SummaryHelper::formatForDisplay($this->state); - $outArr["street"] = SummaryHelper::formatForDisplay($this->street); - return $outArr; - } - /** - * Output in a format suitable for inclusion in a field list. - * - * @return string - */ - public function toFieldList(): string - { - $printable = $this->printableValues(); - $outStr = ""; - $outStr .= "\n :City: " . $printable["city"]; - $outStr .= "\n :Complete Address: " . $printable["complete"]; - $outStr .= "\n :Postal Code: " . $printable["postalCode"]; - $outStr .= "\n :State: " . $printable["state"]; - $outStr .= "\n :Street: " . $printable["street"]; - return rtrim($outStr); - } - - /** - * @return string String representation. - */ - public function __toString(): string - { - return SummaryHelper::cleanOutString($this->toFieldList()); - } -} diff --git a/tests/Product/Us/UsMail/UsMailV2Test.php b/tests/Product/Us/UsMail/UsMailV2Test.php deleted file mode 100644 index 445eba62..00000000 --- a/tests/Product/Us/UsMail/UsMailV2Test.php +++ /dev/null @@ -1,45 +0,0 @@ -completeDoc = new Document(UsMail\UsMailV2::class, $completeDocJSON["document"]); - $this->emptyDoc = new Document(UsMail\UsMailV2::class, $emptyDocJSON["document"]); - $this->completeDocReference = file_get_contents($productDir . "summary_full.rst"); - } - - public function testCompleteDoc() - { - $this->assertEquals($this->completeDocReference, strval($this->completeDoc)); - } - - public function testEmptyDoc() - { - $prediction = $this->emptyDoc->inference->prediction; - $this->assertNull($prediction->senderName->value); - $this->assertNull($prediction->senderAddress->city); - $this->assertNull($prediction->senderAddress->complete); - $this->assertNull($prediction->senderAddress->postalCode); - $this->assertNull($prediction->senderAddress->state); - $this->assertNull($prediction->senderAddress->street); - $this->assertEquals(0, count($prediction->recipientNames)); - $this->assertEquals(0, count($prediction->recipientAddresses)); - } -}