Skip to content

linkbreakers-com/linkbreakers-java

BranchesTags

Repository files navigation

linkbreakers-sdk

Linkbreakers API

  • API version: 1.43.0
    • Generator version: 7.21.0

This is a documentation of all the APIs of Linkbreakers

For more information, please visit https://app.linkbreakers.com

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the Sonatype Central Portal Maven publishing guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.linkbreakers</groupId>
  <artifactId>linkbreakers-sdk</artifactId>
  <version>1.43.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'linkbreakers-sdk' jar has been published to maven central.
    mavenLocal()       // Needed if the 'linkbreakers-sdk' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.linkbreakers:linkbreakers-sdk:1.43.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/linkbreakers-sdk-1.43.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CustomDomainsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.linkbreakers.com");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    CustomDomainsApi apiInstance = new CustomDomainsApi(defaultClient);
    String id = "id_example"; // String | The ID of the custom domain to retrieve (UUID)
    try {
      CheckCustomDomainResponse result = apiInstance.customDomainsServiceCheck(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CustomDomainsApi#customDomainsServiceCheck");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to https://api.linkbreakers.com

Class Method HTTP request Description
CustomDomainsApi customDomainsServiceCheck POST /v1/custom-domains/{id}/check Check a custom domain
CustomDomainsApi customDomainsServiceCreate POST /v1/custom-domains Create a custom domain
CustomDomainsApi customDomainsServiceDelete DELETE /v1/custom-domains/{id} Delete a custom domain
CustomDomainsApi customDomainsServiceGet GET /v1/custom-domains/{id} Get custom domain details
CustomDomainsApi customDomainsServiceList GET /v1/custom-domains List custom domains
CustomDomainsApi customDomainsServiceUpdate PATCH /v1/custom-domains/{id} Update a custom domain
CustomDomainsApi customDomainsServiceValidationInstructions GET /v1/custom-domains/{id}/validation_instructions Get the validation instructions
DirectoriesApi directoriesServiceCreate POST /v1/directories Create a directory
DirectoriesApi directoriesServiceDelete DELETE /v1/directories/{id} Delete a directory
DirectoriesApi directoriesServiceGet GET /v1/directories/{id} Get a directory
DirectoriesApi directoriesServiceList GET /v1/directories List directories
DirectoriesApi directoriesServiceUpdate PATCH /v1/directories/{id} Update a directory
EventsApi eventsServiceListEventTraces GET /v1/events/{eventId}/traces List event traces
EventsApi eventsServiceListEvents GET /v1/events List events
IntegrationsServiceApi integrationsServiceTrack POST /v1/integrations/{slug} Track notifies when an integration installation is attempted
LinkSettingsApi settingsServiceGetLinkSetting GET /v1/settings/link-setting/{id} Get a link setting
LinkSettingsApi settingsServiceUpdateLinkSetting PUT /v1/settings/link-setting/{id} Update a link setting
LinksApi linksServiceCreate POST /v1/links Create a new link
LinksApi linksServiceCreateBulk POST /v1/links/bulk Create multiple links in a single request
LinksApi linksServiceCreateContactLink POST /v1/links/contact Create a new contact card link
LinksApi linksServiceDelete DELETE /v1/links/{id} Delete a link
LinksApi linksServiceGet GET /v1/links/{id} Get link details
LinksApi linksServiceGetLeadScoreExplanation GET /v1/links/{linkId}/lead-score-explanation/{eventId} Get lead score explanation
LinksApi linksServiceList GET /v1/links List links
LinksApi linksServiceShortlinkAvailability GET /v1/links/shortlink-availability Check shortlink availability
LinksApi linksServiceShortlinkRandom GET /v1/links/shortlink-random Get a random shortlink
LinksApi linksServiceUpdate PATCH /v1/links/{id} Update a link
MediaApi mediaServiceCreate POST /v1/media Upload a media file
MediaApi mediaServiceDelete DELETE /v1/media/{id} Delete a media file
MediaApi mediaServiceGet GET /v1/media/{id} Get media file details
MediaApi mediaServiceList GET /v1/media List media files
MembersApi membersServiceAllowAccess POST /v1/members/{id}/allow Allow access for a member
MembersApi membersServiceDelete DELETE /v1/members/{id} Delete a member
MembersApi membersServiceForceSignout POST /v1/members/{id}/signout Force a member to sign out
MembersApi membersServiceGet GET /v1/members/{id} Get a member by ID
MembersApi membersServiceGetMyself GET /v1/member Get the current member
MembersApi membersServiceInvite POST /v1/members/invite Invite a new member
MembersApi membersServiceList GET /v1/members List members
MembersApi membersServiceRevokeAccess POST /v1/members/{id}/revoke Revoke access for a member
MembersApi membersServiceUpdate PUT /v1/members/{id} Update a member
MembersApi membersServiceUpdateMyself PUT /v1/member Update the current member
PageThemesApi pageThemesServiceGetPageTheme GET /v1/page-themes/{id} Get a page theme
PageThemesApi pageThemesServiceListPageThemes GET /v1/page-themes List page themes for the current workspace
PageThemesApi pageThemesServiceUpdatePageTheme PATCH /v1/page-themes/{id} Update a page theme
QrCodeDesignsApi qrcodeDesignServiceDelete DELETE /v1/qrcode-designs/{id} Delete a QR code design
QrCodeDesignsApi qrcodeDesignServiceGet GET /v1/qrcode-designs/{id} Get a QR code design
QrCodeDesignsApi qrcodeDesignServicePublicCreate POST /v1/public/qrcode-designs Create a new QR code design
QrCodeDesignsApi qrcodeDesignServiceUpdate PATCH /v1/qrcode-designs/{id} Update a QR code design
QrCodeTemplatesApi qrcodeTemplatesServiceCreateQrcodeTemplate POST /v1/qrcode-templates Create a new QR code template
QrCodeTemplatesApi qrcodeTemplatesServiceDeleteQrcodeTemplate DELETE /v1/qrcode-templates/{id} Delete a workspace QR code template
QrCodeTemplatesApi qrcodeTemplatesServiceGetQrcodeTemplate GET /v1/qrcode-templates/{id} Get a workspace QR code template
QrCodeTemplatesApi qrcodeTemplatesServiceImportQrcodeTemplate POST /v1/qrcode-templates/import Import a public QR code template
QrCodeTemplatesApi qrcodeTemplatesServiceListQrcodeTemplates GET /v1/qrcode-templates List my QR code templates
QrCodeTemplatesApi qrcodeTemplatesServicePublicGetQrcodeTemplate GET /v1/public/qrcode-templates/{slug} Get a public QR code template
QrCodeTemplatesApi qrcodeTemplatesServicePublicListQrcodeTemplates GET /v1/public/qrcode-templates List QR code templates
QrCodeTemplatesApi qrcodeTemplatesServicePublishQrcodeTemplate POST /v1/qrcode-templates/{id}/publish Publish a workspace QR code template
QrCodeTemplatesApi qrcodeTemplatesServiceUpdateQrcodeTemplate PATCH /v1/qrcode-templates/{id} Update a workspace QR code template
TagsApi tagsServiceDelete DELETE /v1/tags Delete tags
TagsApi tagsServiceList GET /v1/tags List tags
TimeSeriesApi timeSeriesServiceGetEventsTimeSeries POST /v1/timeseries/events Get events time series
VisitorsApi visitorsServiceDelete DELETE /v1/visitors/{id} Delete a visitor
VisitorsApi visitorsServiceDeleteAttribute DELETE /v1/visitors/{id}/attributes/{attributeKey} Delete a visitor attribute
VisitorsApi visitorsServiceGet GET /v1/visitors/{id} Get a visitor
VisitorsApi visitorsServiceIdentify POST /v1/visitor/identify Identify visitor
VisitorsApi visitorsServiceList GET /v1/visitors List visitors
VisitorsApi visitorsServiceUpdate PATCH /v1/visitors/{id} Update a visitor
WebhooksApi webhooksServiceCreate POST /v1/webhooks Create a webhook
WebhooksApi webhooksServiceDelete DELETE /v1/webhooks/{id} Delete a webhook
WebhooksApi webhooksServiceGet GET /v1/webhooks/{id} Get a webhook
WebhooksApi webhooksServiceList GET /v1/webhooks List webhooks
WebhooksApi webhooksServiceUpdate PATCH /v1/webhooks/{id} Update a webhook
WorkflowStepsApi workflowStepsServiceAddRelationship POST /v1/links/{linkId}/workflow-steps/{parentStepId}/relationships Add relationship between workflow steps
WorkflowStepsApi workflowStepsServiceCreate POST /v1/links/{linkId}/workflow-steps Create a new workflow step
WorkflowStepsApi workflowStepsServiceDelete DELETE /v1/links/{linkId}/workflow-steps/{id} Delete a workflow step
WorkflowStepsApi workflowStepsServiceGet GET /v1/links/{linkId}/workflow-steps/{id} Get workflow step details
WorkflowStepsApi workflowStepsServiceList GET /v1/links/{linkId}/workflow-steps List workflow steps for a link
WorkflowStepsApi workflowStepsServiceRemoveRelationship DELETE /v1/links/{linkId}/workflow-steps/{parentStepId}/relationships/{childStepId} Remove relationship between workflow steps
WorkflowStepsApi workflowStepsServiceUpdate PATCH /v1/links/{linkId}/workflow-steps/{id} Update a workflow step
WorkspaceMetricsApi metricsServiceGetEventsMetric GET /v1/metrics/events Get events metric
WorkspaceMetricsApi metricsServiceGetWorkspaceInsight GET /v1/metrics/workspace/insight Get workspace insight
WorkspaceMetricsApi metricsServiceGetWorkspaceMetric GET /v1/metrics/workspace Get workspace metric
WorkspaceTokensApi workspaceTokensServiceCreate POST /v1/workspace-tokens Create a workspace token
WorkspaceTokensApi workspaceTokensServiceDelete DELETE /v1/workspace-tokens/{id} Delete a workspace token
WorkspaceTokensApi workspaceTokensServiceGet GET /v1/workspace-tokens/{id} Get a workspace token
WorkspaceTokensApi workspaceTokensServiceList GET /v1/workspace-tokens List workspace tokens
WorkspacesApi workspacesServiceDelete DELETE /v1/workspace Delete workspace
WorkspacesApi workspacesServiceGetMyWorkspace GET /v1/workspace Get my workspace
WorkspacesApi workspacesServiceGetWorkspace GET /v1/workspaces/{id} Get a workspace by ID
WorkspacesApi workspacesServicePublicGetWorkspace GET /v1/public/workspaces/{slug} Get a public workspace by slug
WorkspacesApi workspacesServiceRequestEnrollment POST /v1/workspace/request-enrollment Request workspace enrollment
WorkspacesApi workspacesServiceUpdate PUT /v1/workspace Update a workspace
WorkspacesApi workspacesServiceUpdateOriginInquiry POST /v1/workspace/origin-inquiry Update workspace origin inquiry
WorkspacesApi workspacesServiceUpdateOriginPurpose POST /v1/workspace/origin-purpose Update workspace origin purpose

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: HTTP Bearer Token authentication (JWT)

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

16 tags

Packages

 
 
 

Contributors

Languages