Skip to content

LP-1231: Update javadocs and deploy config #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alejouribesanchez merged 3 commits into from
Aug 6, 2025
Merged

LP-1231: Update javadocs and deploy config #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e9ef46f
LP-1231: Update javadocs
Aug 6, 2025
af1e47f
LP-1231: Update deploy config
Aug 6, 2025
4067a29
LP-1231: Update javadocs
Aug 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/maven-publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ jobs:
contents: read
packages: write
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Set up Java for publishing to Maven Central Repository
uses: actions/setup-java@v2
uses: actions/setup-java@v4
with:
java-version: '16'
distribution: 'adopt'
server-id: ossrh
server-id: central
server-username: MAVEN_USERNAME
server-password: MAVEN_PASSWORD
gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }} # Value of the GPG private key to import
gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
- name: Publish to Maven Central Repository
run: mvn --batch-mode deploy
env:
MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
MAVEN_USERNAME: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
MAVEN_PASSWORD: ${{ secrets.MAVEN_CENTRAL_TOKEN }}
MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ Install the package using Maven:
<dependency>
<groupId>com.veryfi</groupId>
<artifactId>veryfi-java</artifactId>
<version>2.1.0</version>
<version>2.1.1</version>
</dependency>
```
Install the package using Gradle:
```bash
implementation group: 'com.veryfi', name: 'veryfi-java', version: '2.1.0'
implementation group: 'com.veryfi', name: 'veryfi-java', version: '2.1.1'
```

## Getting Started
Expand Down
64 changes: 40 additions & 24 deletions docs/allclasses-index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Dec 13 16:03:21 COT 2024 -->
<title>All Classes and Interfaces (veryfi-java 2.0.0 API)</title>
<!-- Generated by javadoc (17) on Tue Aug 05 20:11:45 COT 2025 -->
<title>All Classes and Interfaces (veryfi-java 2.1.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2024-12-13">
<meta name="dc.created" content="2025-08-05">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="all-classes-index-page">
Expand Down Expand Up @@ -62,39 +62,55 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="veryfi/models/AddLineItem.html" title="class in veryfi.models">AddLineItem</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="veryfi/Client.html" title="interface in veryfi">Client</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">Veryfi API client for Java.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="veryfi/services/ClientImpl.html" title="class in veryfi.services">ClientImpl</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Model class for adding line items to documents.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="veryfi/Base64Helper.html" title="class in veryfi">Base64Helper</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Utility class for Base64 encoding operations.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="veryfi/Client.html" title="interface in veryfi">Client</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
<div class="block">Veryfi API client for Java.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="veryfi/Constants.html" title="class in veryfi">Constants</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="veryfi/services/ClientImpl.html" title="class in veryfi.services">ClientImpl</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">header constants for HttpRequests.</div>
<div class="block">Veryfi API client for Java.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="veryfi/Credentials.html" title="class in veryfi">Credentials</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="veryfi/Constants.html" title="class in veryfi">Constants</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Constants used throughout the Veryfi Java SDK.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="veryfi/Credentials.html" title="class in veryfi">Credentials</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Veryfi credentials for API access</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="veryfi/enums/Endpoint.html" title="enum class in veryfi.enums">Endpoint</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="veryfi/enums/HttpMethod.html" title="enum class in veryfi.enums">HttpMethod</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="veryfi/enums/Endpoint.html" title="enum class in veryfi.enums">Endpoint</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
<div class="block">Enumeration of Veryfi API endpoints.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="veryfi/enums/HttpMethod.html" title="enum class in veryfi.enums">HttpMethod</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
<div class="block">Enum constants for Http methods.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="veryfi/NetworkClient.html" title="class in veryfi">NetworkClient</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab5"><a href="veryfi/models/NotValidModelException.html" title="class in veryfi.models">NotValidModelException</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab5">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="veryfi/NetworkClient.html" title="class in veryfi">NetworkClient</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="veryfi/models/NotValidModelException.html" title="class in veryfi.models">NotValidModelException</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
<div class="block">Not Valid Model Exception</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="veryfi/models/SharedLineItem.html" title="class in veryfi.models">SharedLineItem</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="veryfi/models/SharedLineItem.html" title="class in veryfi.models">SharedLineItem</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Abstract base class for line item models.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="veryfi/services/SplitServices.html" title="class in veryfi.services">SplitServices</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">API services for PDF Split Processing</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="veryfi/models/UpdateLineItem.html" title="class in veryfi.models">UpdateLineItem</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Model class for updating line items in documents.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="veryfi/VeryfiClientFactory.html" title="class in veryfi">VeryfiClientFactory</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Factory for creating instances of <a href="veryfi/Client.html" title="interface in veryfi"><code>Client</code></a>.</div>
Expand All @@ -105,7 +121,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024. All rights reserved.</small></p>
<p class="legal-copy"><small>Copyright &#169; 2025. All rights reserved.</small></p>
</footer>
</div>
</div>
Expand Down
10 changes: 5 additions & 5 deletions docs/allpackages-index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Dec 13 16:03:21 COT 2024 -->
<title>All Packages (veryfi-java 2.0.0 API)</title>
<!-- Generated by javadoc (17) on Tue Aug 05 20:11:45 COT 2025 -->
<title>All Packages (veryfi-java 2.1.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2024-12-13">
<meta name="dc.created" content="2025-08-05">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="all-packages-index-page">
Expand Down Expand Up @@ -67,7 +67,7 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024. All rights reserved.</small></p>
<p class="legal-copy"><small>Copyright &#169; 2025. All rights reserved.</small></p>
</footer>
</div>
</div>
Expand Down
12 changes: 6 additions & 6 deletions docs/constant-values.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Dec 13 16:03:21 COT 2024 -->
<title>Constant Field Values (veryfi-java 2.0.0 API)</title>
<!-- Generated by javadoc (17) on Tue Aug 05 20:11:45 COT 2025 -->
<title>Constant Field Values (veryfi-java 2.1.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2024-12-13">
<meta name="dc.created" content="2025-08-05">
<meta name="description" content="summary of constants">
<meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="constants-summary-page">
Expand Down Expand Up @@ -122,7 +122,7 @@ <h2 title="veryfi">veryfi.*</h2>
<div class="col-last odd-row-color"><code>"User-Agent"</code></div>
<div class="col-first even-row-color"><code id="veryfi.Constants.USER_AGENT_JAVA">public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="veryfi/Constants.html#USER_AGENT_JAVA">USER_AGENT_JAVA</a></code></div>
<div class="col-last even-row-color"><code>"Java Veryfi-Java/2.0.0"</code></div>
<div class="col-last even-row-color"><code>"Java Veryfi-Java/2.1.0"</code></div>
<div class="col-first odd-row-color"><code id="veryfi.Constants.X_VERYFI_REQUEST_SIGNATURE">public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="veryfi/Constants.html#X_VERYFI_REQUEST_SIGNATURE">X_VERYFI_REQUEST_SIGNATURE</a></code></div>
<div class="col-last odd-row-color"><code>"X-Veryfi-Request-Signature"</code></div>
Expand All @@ -136,7 +136,7 @@ <h2 title="veryfi">veryfi.*</h2>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024. All rights reserved.</small></p>
<p class="legal-copy"><small>Copyright &#169; 2025. All rights reserved.</small></p>
</footer>
</div>
</div>
Expand Down
10 changes: 5 additions & 5 deletions docs/help-doc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Dec 13 16:03:21 COT 2024 -->
<title>API Help (veryfi-java 2.0.0 API)</title>
<!-- Generated by javadoc (17) on Tue Aug 05 20:11:45 COT 2025 -->
<title>API Help (veryfi-java 2.1.0 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2024-12-13">
<meta name="dc.created" content="2025-08-05">
<meta name="description" content="help">
<meta name="generator" content="javadoc/HelpWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="help-page">
Expand Down Expand Up @@ -188,7 +188,7 @@ <h3>Index</h3>
<span class="help-footnote">This help file applies to API documentation generated by the standard doclet.</span></main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024. All rights reserved.</small></p>
<p class="legal-copy"><small>Copyright &#169; 2025. All rights reserved.</small></p>
</footer>
</div>
</div>
Expand Down
Loading
Loading