fix: unblock Java releases and replace the stale README

.github/workflows/docs-check.yml

@@ -0,0 +1,18 @@
+name: Docs check
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  check-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: maven
+      - run: ./scripts/check-docs.sh

.github/workflows/update-and-publish.yml

@@ -90,6 +90,9 @@ jobs:
             -g java \
             -o . \
             --skip-validate-spec \
+            --git-host github.com \
+            --git-user-id linkbreakers-com \
+            --git-repo-id linkbreakers-java \
             --global-property apiTests=false,modelTests=false,apiDocs=false,modelDocs=false \
             --additional-properties=groupId=com.linkbreakers,artifactId=linkbreakers-sdk,artifactVersion=$NEW_VERSION,invokerPackage=com.linkbreakers,apiPackage=com.linkbreakers.api,modelPackage=com.linkbreakers.model,library=okhttp-gson,dateLibrary=java8,hideGenerationTimestamp=true
 
@@ -123,6 +126,10 @@ jobs:
           mvn clean package -DskipTests
           echo "✅ Maven build completed"
 
+      - name: Check README against the generated SDK
+        if: steps.compare.outputs.needs_update == 'true'
+        run: ./scripts/check-docs.sh
+
       - name: Import GPG key
         if: steps.compare.outputs.needs_update == 'true'
         env:

.openapi-generator/FILES

@@ -27,22 +27,28 @@ src/main/java/com/linkbreakers/ProgressResponseBody.java
 src/main/java/com/linkbreakers/ServerConfiguration.java
 src/main/java/com/linkbreakers/ServerVariable.java
 src/main/java/com/linkbreakers/StringUtil.java
+src/main/java/com/linkbreakers/api/AgentIdentityApi.java
+src/main/java/com/linkbreakers/api/AllowancesApi.java
 src/main/java/com/linkbreakers/api/AnalyticsDashboardApi.java
 src/main/java/com/linkbreakers/api/AnalyticsDataApi.java
+src/main/java/com/linkbreakers/api/ApiScopesApi.java
 src/main/java/com/linkbreakers/api/AssistantApi.java
 src/main/java/com/linkbreakers/api/CustomDomainsApi.java
 src/main/java/com/linkbreakers/api/DirectoriesApi.java
 src/main/java/com/linkbreakers/api/EventsApi.java
 src/main/java/com/linkbreakers/api/GoogleFormsIntegrationsApi.java
 src/main/java/com/linkbreakers/api/IntegrationsServiceApi.java
+src/main/java/com/linkbreakers/api/JobsApi.java
 src/main/java/com/linkbreakers/api/LinkSettingsApi.java
 src/main/java/com/linkbreakers/api/LinksApi.java
 src/main/java/com/linkbreakers/api/MediaApi.java
 src/main/java/com/linkbreakers/api/MembersApi.java
 src/main/java/com/linkbreakers/api/PageThemeTemplatesApi.java
 src/main/java/com/linkbreakers/api/PageThemesApi.java
+src/main/java/com/linkbreakers/api/PricingApi.java
 src/main/java/com/linkbreakers/api/QrCodeDesignsApi.java
 src/main/java/com/linkbreakers/api/QrCodeTemplatesApi.java
+src/main/java/com/linkbreakers/api/SandboxesApi.java
 src/main/java/com/linkbreakers/api/SlackIntegrationsApi.java
 src/main/java/com/linkbreakers/api/TagsApi.java
 src/main/java/com/linkbreakers/api/TimeSeriesApi.java
@@ -56,12 +62,21 @@ src/main/java/com/linkbreakers/auth/ApiKeyAuth.java
 src/main/java/com/linkbreakers/auth/Authentication.java
 src/main/java/com/linkbreakers/auth/HttpBasicAuth.java
 src/main/java/com/linkbreakers/auth/HttpBearerAuth.java
+src/main/java/com/linkbreakers/auth/OAuth.java
+src/main/java/com/linkbreakers/auth/OAuthFlow.java
+src/main/java/com/linkbreakers/auth/OAuthOkHttpClient.java
+src/main/java/com/linkbreakers/auth/RetryingOAuth.java
 src/main/java/com/linkbreakers/model/AbstractOpenApiSchema.java
 src/main/java/com/linkbreakers/model/Action.java
+src/main/java/com/linkbreakers/model/AgentClaim.java
+src/main/java/com/linkbreakers/model/AgentClaimStatus.java
 src/main/java/com/linkbreakers/model/AnalyticsDashboard.java
 src/main/java/com/linkbreakers/model/AnalyticsDashboardServiceGenerateWidgetSummaryBody.java
 src/main/java/com/linkbreakers/model/AnalyticsDashboardServiceUpdateDashboardBody.java
 src/main/java/com/linkbreakers/model/AnalyticsWidgetResult.java
+src/main/java/com/linkbreakers/model/ApiScope.java
+src/main/java/com/linkbreakers/model/ApiScopeAccess.java
+src/main/java/com/linkbreakers/model/ApiScopeInfo.java
 src/main/java/com/linkbreakers/model/ApiTag.java
 src/main/java/com/linkbreakers/model/ApplyPageThemeTemplateRequest.java
 src/main/java/com/linkbreakers/model/ApplyPageThemeTemplateResponse.java
@@ -82,12 +97,14 @@ src/main/java/com/linkbreakers/model/AttributeWrite.java
 src/main/java/com/linkbreakers/model/AttributeWriteMode.java
 src/main/java/com/linkbreakers/model/AutoLayoutWorkflowResponse.java
 src/main/java/com/linkbreakers/model/BackgroundOptions.java
+src/main/java/com/linkbreakers/model/BillingInterval.java
 src/main/java/com/linkbreakers/model/BreakdownDataPoint.java
 src/main/java/com/linkbreakers/model/CanvasPosition.java
 src/main/java/com/linkbreakers/model/ChatDisplayMessage.java
 src/main/java/com/linkbreakers/model/ChatUIAction.java
 src/main/java/com/linkbreakers/model/ChatUIOption.java
 src/main/java/com/linkbreakers/model/CheckCustomDomainResponse.java
+src/main/java/com/linkbreakers/model/ClaimAgentWorkspaceRequest.java
 src/main/java/com/linkbreakers/model/ClientRedirectPayload.java
 src/main/java/com/linkbreakers/model/CompleteGoogleFormsOAuthRequest.java
 src/main/java/com/linkbreakers/model/CompleteGoogleFormsOAuthResponse.java
@@ -124,13 +141,16 @@ src/main/java/com/linkbreakers/model/CreatePageThemeTemplateRequest.java
 src/main/java/com/linkbreakers/model/CreatePageThemeTemplateResponse.java
 src/main/java/com/linkbreakers/model/CreateQrcodeTemplateRequest.java
 src/main/java/com/linkbreakers/model/CreateQrcodeTemplateResponse.java
+src/main/java/com/linkbreakers/model/CreateSandboxRequest.java
+src/main/java/com/linkbreakers/model/CreateSandboxResponse.java
 src/main/java/com/linkbreakers/model/CreateThankYouLinkRequest.java
 src/main/java/com/linkbreakers/model/CreateThankYouLinkResponse.java
 src/main/java/com/linkbreakers/model/CreateWebhookRequest.java
 src/main/java/com/linkbreakers/model/CreateWebhookResponse.java
 src/main/java/com/linkbreakers/model/CreateWorkflowStepResponse.java
 src/main/java/com/linkbreakers/model/CreateWorkspaceTokenRequest.java
 src/main/java/com/linkbreakers/model/CreateWorkspaceTokenResponse.java
+src/main/java/com/linkbreakers/model/CreditTopup.java
 src/main/java/com/linkbreakers/model/CustomDomain.java
 src/main/java/com/linkbreakers/model/CustomDomainDnsRecord.java
 src/main/java/com/linkbreakers/model/CustomDomainOneClickSetup.java
@@ -187,6 +207,7 @@ src/main/java/com/linkbreakers/model/DigestFrequency.java
 src/main/java/com/linkbreakers/model/DirectoriesServiceUpdateBody.java
 src/main/java/com/linkbreakers/model/Directory.java
 src/main/java/com/linkbreakers/model/DisconnectWorkflowStepResponse.java
+src/main/java/com/linkbreakers/model/DismissAllowanceNoticeRequest.java
 src/main/java/com/linkbreakers/model/DnsProvider.java
 src/main/java/com/linkbreakers/model/DnsRecordPurpose.java
 src/main/java/com/linkbreakers/model/DnsRecordType.java
@@ -215,6 +236,7 @@ src/main/java/com/linkbreakers/model/FunnelBranch.java
 src/main/java/com/linkbreakers/model/FunnelStep.java
 src/main/java/com/linkbreakers/model/GenerateWidgetSummaryResponse.java
 src/main/java/com/linkbreakers/model/GeoDataPoint.java
+src/main/java/com/linkbreakers/model/GetAgentClaimRequest.java
 src/main/java/com/linkbreakers/model/GetAttributeDistributionRequest.java
 src/main/java/com/linkbreakers/model/GetAttributeDistributionResponse.java
 src/main/java/com/linkbreakers/model/GetAttributeMetricRequest.java
@@ -269,12 +291,19 @@ src/main/java/com/linkbreakers/model/ImportPageThemeTemplateResponse.java
 src/main/java/com/linkbreakers/model/ImportQrcodeTemplateRequest.java
 src/main/java/com/linkbreakers/model/ImportQrcodeTemplateResponse.java
 src/main/java/com/linkbreakers/model/InviteMemberRequest.java
+src/main/java/com/linkbreakers/model/Job.java
+src/main/java/com/linkbreakers/model/JobError.java
+src/main/java/com/linkbreakers/model/JobStatus.java
+src/main/java/com/linkbreakers/model/JobType.java
 src/main/java/com/linkbreakers/model/JourneyProgress.java
 src/main/java/com/linkbreakers/model/Link.java
 src/main/java/com/linkbreakers/model/LinkSetting.java
 src/main/java/com/linkbreakers/model/LinkSortField.java
 src/main/java/com/linkbreakers/model/LinkView.java
+src/main/java/com/linkbreakers/model/LinksBulkCreateResult.java
 src/main/java/com/linkbreakers/model/LinksServiceUpdateBody.java
+src/main/java/com/linkbreakers/model/ListAllowancesResponse.java
+src/main/java/com/linkbreakers/model/ListApiScopesResponse.java
 src/main/java/com/linkbreakers/model/ListCustomDomainsResponse.java
 src/main/java/com/linkbreakers/model/ListDashboardsResponse.java
 src/main/java/com/linkbreakers/model/ListDetectedGoogleFormsResponse.java
@@ -287,8 +316,10 @@ src/main/java/com/linkbreakers/model/ListLinksResponse.java
 src/main/java/com/linkbreakers/model/ListMediaResponse.java
 src/main/java/com/linkbreakers/model/ListPageThemeTemplatesResponse.java
 src/main/java/com/linkbreakers/model/ListPageThemesResponse.java
+src/main/java/com/linkbreakers/model/ListPricingPlansResponse.java
 src/main/java/com/linkbreakers/model/ListQrcodeTemplatesResponse.java
 src/main/java/com/linkbreakers/model/ListResponse.java
+src/main/java/com/linkbreakers/model/ListSandboxesResponse.java
 src/main/java/com/linkbreakers/model/ListSlackChannelsResponse.java
 src/main/java/com/linkbreakers/model/ListTagsResponse.java
 src/main/java/com/linkbreakers/model/ListVisitorAttributeKeysResponse.java
@@ -307,6 +338,7 @@ src/main/java/com/linkbreakers/model/Member.java
 src/main/java/com/linkbreakers/model/MembersServiceUpdateBody.java
 src/main/java/com/linkbreakers/model/MessagePageNavigationType.java
 src/main/java/com/linkbreakers/model/MessagePagePayload.java
+src/main/java/com/linkbreakers/model/Money.java
 src/main/java/com/linkbreakers/model/MultiLinkButton.java
 src/main/java/com/linkbreakers/model/MultiLinkPayload.java
 src/main/java/com/linkbreakers/model/MultiLinkTraceButton.java
@@ -328,7 +360,15 @@ src/main/java/com/linkbreakers/model/PageThemeTemplatesServiceUpdatePageThemeTem
 src/main/java/com/linkbreakers/model/PageThemesServiceUpdatePageThemeBody.java
 src/main/java/com/linkbreakers/model/PasswordPayload.java
 src/main/java/com/linkbreakers/model/PasswordTraceData.java
+src/main/java/com/linkbreakers/model/PlanFeature.java
+src/main/java/com/linkbreakers/model/PlanLimit.java
+src/main/java/com/linkbreakers/model/PlanLimitKey.java
+src/main/java/com/linkbreakers/model/PlanLimitKind.java
+src/main/java/com/linkbreakers/model/PlanPrice.java
+src/main/java/com/linkbreakers/model/PlanTrial.java
 src/main/java/com/linkbreakers/model/PreferredLinkType.java
+src/main/java/com/linkbreakers/model/PricingPlan.java
+src/main/java/com/linkbreakers/model/PricingPlanId.java
 src/main/java/com/linkbreakers/model/ProtobufAny.java
 src/main/java/com/linkbreakers/model/ProtobufNullValue.java
 src/main/java/com/linkbreakers/model/PublicCreateQrcodeDesignRequest.java
@@ -356,6 +396,7 @@ src/main/java/com/linkbreakers/model/ResolveQrcodeTemplateImagesResponse.java
 src/main/java/com/linkbreakers/model/ResolveStepCollisionsResponse.java
 src/main/java/com/linkbreakers/model/ResponseFormat.java
 src/main/java/com/linkbreakers/model/Role.java
+src/main/java/com/linkbreakers/model/Sandbox.java
 src/main/java/com/linkbreakers/model/SettingsServiceUpdateLinkSettingBody.java
 src/main/java/com/linkbreakers/model/Shape.java
 src/main/java/com/linkbreakers/model/ShortlinkAvailabilityResponse.java
@@ -402,6 +443,7 @@ src/main/java/com/linkbreakers/model/TimeSeriesPoint.java
 src/main/java/com/linkbreakers/model/TimeSeriesSeries.java
 src/main/java/com/linkbreakers/model/TopLinkDataPoint.java
 src/main/java/com/linkbreakers/model/TriggeredBy.java
+src/main/java/com/linkbreakers/model/TypeDate.java
 src/main/java/com/linkbreakers/model/UpdateCustomDomainResponse.java
 src/main/java/com/linkbreakers/model/UpdateDashboardResponse.java
 src/main/java/com/linkbreakers/model/UpdateDeviceResponse.java
@@ -423,6 +465,7 @@ src/main/java/com/linkbreakers/model/UpdateWorkflowStepResponse.java
 src/main/java/com/linkbreakers/model/UpdateWorkspaceOriginInquiryRequest.java
 src/main/java/com/linkbreakers/model/UpdateWorkspaceOriginPurposeRequest.java
 src/main/java/com/linkbreakers/model/UpdateWorkspaceRequest.java
+src/main/java/com/linkbreakers/model/UpdateWorkspaceTokenResponse.java
 src/main/java/com/linkbreakers/model/VCardData.java
 src/main/java/com/linkbreakers/model/VCardPayload.java
 src/main/java/com/linkbreakers/model/VCardSocialLink.java
@@ -474,7 +517,9 @@ src/main/java/com/linkbreakers/model/WorkflowStepsServiceConnectStepBody.java
 src/main/java/com/linkbreakers/model/WorkflowStepsServiceCreateBody.java
 src/main/java/com/linkbreakers/model/WorkflowStepsServiceUpdateBody.java
 src/main/java/com/linkbreakers/model/Workspace.java
+src/main/java/com/linkbreakers/model/WorkspaceAllowance.java
 src/main/java/com/linkbreakers/model/WorkspaceInsight.java
 src/main/java/com/linkbreakers/model/WorkspaceMetric.java
 src/main/java/com/linkbreakers/model/WorkspaceToken.java
 src/main/java/com/linkbreakers/model/WorkspaceTokenKeyType.java
+src/main/java/com/linkbreakers/model/WorkspaceTokensServiceUpdateBody.java