linkbreakers 1.34.0

package/dist/apis/LinkSettingsApi.js

@@ -0,0 +1,146 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Linkbreakers API
+ * This is a documentation of all the APIs of Linkbreakers
+ *
+ * The version of the OpenAPI document: 1.34.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LinkSettingsApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class LinkSettingsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for settingsServiceGetLinkSetting without sending the request
+     */
+    async settingsServiceGetLinkSettingRequestOpts(requestParameters) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling settingsServiceGetLinkSetting().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/settings/link-setting/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieve the current visitor data collection configuration for a link.
+     * Get a link setting
+     */
+    async settingsServiceGetLinkSettingRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.settingsServiceGetLinkSettingRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetLinkSettingResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Retrieve the current visitor data collection configuration for a link.
+     * Get a link setting
+     */
+    async settingsServiceGetLinkSetting(requestParameters, initOverrides) {
+        const response = await this.settingsServiceGetLinkSettingRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for settingsServiceUpdateLinkSetting without sending the request
+     */
+    async settingsServiceUpdateLinkSettingRequestOpts(requestParameters) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling settingsServiceUpdateLinkSetting().');
+        }
+        if (requestParameters['settingsServiceUpdateLinkSettingBody'] == null) {
+            throw new runtime.RequiredError('settingsServiceUpdateLinkSettingBody', 'Required parameter "settingsServiceUpdateLinkSettingBody" was null or undefined when calling settingsServiceUpdateLinkSetting().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/v1/settings/link-setting/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.SettingsServiceUpdateLinkSettingBodyToJSON)(requestParameters['settingsServiceUpdateLinkSettingBody']),
+        };
+    }
+    /**
+     * Adjust the data collection policy associated with a specific link.
+     * Update a link setting
+     */
+    async settingsServiceUpdateLinkSettingRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.settingsServiceUpdateLinkSettingRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UpdateLinkSettingResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Adjust the data collection policy associated with a specific link.
+     * Update a link setting
+     */
+    async settingsServiceUpdateLinkSetting(requestParameters, initOverrides) {
+        const response = await this.settingsServiceUpdateLinkSettingRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+exports.LinkSettingsApi = LinkSettingsApi;

package/dist/apis/LinksApi.d.ts

@@ -0,0 +1,431 @@
+/**
+ * Linkbreakers API
+ * This is a documentation of all the APIs of Linkbreakers
+ *
+ * The version of the OpenAPI document: 1.34.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CreateBulkLinksRequest, CreateBulkLinksResponse, CreateContactLinkRequest, CreateContactLinkResponse, CreateLinkRequest, CreateLinkResponse, GetLeadScoreExplanationResponse, GetLinkResponse, LinksServiceUpdateBody, ListLinksResponse, ShortlinkAvailabilityResponse, ShortlinkRandomResponse, UpdateLinkResponse } from '../models/index';
+export interface LinksServiceCreateRequest {
+    createLinkRequest: CreateLinkRequest;
+}
+export interface LinksServiceCreateBulkRequest {
+    createBulkLinksRequest: CreateBulkLinksRequest;
+}
+export interface LinksServiceCreateContactLinkRequest {
+    createContactLinkRequest: CreateContactLinkRequest;
+}
+export interface LinksServiceDeleteRequest {
+    id: string;
+}
+export interface LinksServiceGetRequest {
+    id: string;
+    include?: Array<string>;
+}
+export interface LinksServiceGetLeadScoreExplanationRequest {
+    linkId: string;
+    eventId: string;
+}
+export interface LinksServiceListRequest {
+    pageSize: number;
+    pageToken?: string;
+    include?: Array<string>;
+    tags?: Array<string>;
+    search?: string;
+    sortBy?: string;
+    sortDirection?: string;
+}
+export interface LinksServiceShortlinkAvailabilityRequest {
+    shortlink?: string;
+    customDomainId?: string;
+}
+export interface LinksServiceUpdateRequest {
+    id: string;
+    linksServiceUpdateBody: LinksServiceUpdateBody;
+}
+/**
+ * LinksApi - interface
+ *
+ * @export
+ * @interface LinksApiInterface
+ */
+export interface LinksApiInterface {
+    /**
+     * Creates request options for linksServiceCreate without sending the request
+     * @param {CreateLinkRequest} createLinkRequest
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceCreateRequestOpts(requestParameters: LinksServiceCreateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * This endpoint allows users to create a new shortened URL link in their Linkbreakers workspace. The URL will be checked for malicious content before being shortened.
+     * @summary Create a new link
+     * @param {CreateLinkRequest} createLinkRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceCreateRaw(requestParameters: LinksServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateLinkResponse>>;
+    /**
+     * This endpoint allows users to create a new shortened URL link in their Linkbreakers workspace. The URL will be checked for malicious content before being shortened.
+     * Create a new link
+     */
+    linksServiceCreate(requestParameters: LinksServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateLinkResponse>;
+    /**
+     * Creates request options for linksServiceCreateBulk without sending the request
+     * @param {CreateBulkLinksRequest} createBulkLinksRequest
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceCreateBulkRequestOpts(requestParameters: LinksServiceCreateBulkRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates links in batch using the same per-link options as Create. This operation is transactional: if one link fails validation or insertion, no links from the batch are created.
+     * @summary Create multiple links in a single request
+     * @param {CreateBulkLinksRequest} createBulkLinksRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceCreateBulkRaw(requestParameters: LinksServiceCreateBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateBulkLinksResponse>>;
+    /**
+     * Creates links in batch using the same per-link options as Create. This operation is transactional: if one link fails validation or insertion, no links from the batch are created.
+     * Create multiple links in a single request
+     */
+    linksServiceCreateBulk(requestParameters: LinksServiceCreateBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateBulkLinksResponse>;
+    /**
+     * Creates request options for linksServiceCreateContactLink without sending the request
+     * @param {CreateContactLinkRequest} createContactLinkRequest
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceCreateContactLinkRequestOpts(requestParameters: LinksServiceCreateContactLinkRequest): Promise<runtime.RequestOpts>;
+    /**
+     * This endpoint allows users to create a new vCard contact link in their Linkbreakers workspace. The link will generate a vCard file for contact information sharing.
+     * @summary Create a new contact card link
+     * @param {CreateContactLinkRequest} createContactLinkRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceCreateContactLinkRaw(requestParameters: LinksServiceCreateContactLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateContactLinkResponse>>;
+    /**
+     * This endpoint allows users to create a new vCard contact link in their Linkbreakers workspace. The link will generate a vCard file for contact information sharing.
+     * Create a new contact card link
+     */
+    linksServiceCreateContactLink(requestParameters: LinksServiceCreateContactLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateContactLinkResponse>;
+    /**
+     * Creates request options for linksServiceDelete without sending the request
+     * @param {string} id The ID of the link to delete (UUID)
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceDeleteRequestOpts(requestParameters: LinksServiceDeleteRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Removes a shortened link from the workspace. This operation cannot be undone.
+     * @summary Delete a link
+     * @param {string} id The ID of the link to delete (UUID)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceDeleteRaw(requestParameters: LinksServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Removes a shortened link from the workspace. This operation cannot be undone.
+     * Delete a link
+     */
+    linksServiceDelete(requestParameters: LinksServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Creates request options for linksServiceGet without sending the request
+     * @param {string} id The ID of the link to retrieve (UUID)
+     * @param {Array<string>} [include] List of related resources to include in the response. Supported values: \&quot;customDomain\&quot;, \&quot;qrcodeDesign\&quot;, \&quot;qrcodeSignedUrl\&quot;, \&quot;tags\&quot;, \&quot;pageTheme\&quot;. Use \&quot;qrcodeSignedUrl\&quot; to fetch signed QR image URLs—they are omitted by default to keep requests fast.
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceGetRequestOpts(requestParameters: LinksServiceGetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves information about a shortened link including its metadata and metrics.
+     * @summary Get link details
+     * @param {string} id The ID of the link to retrieve (UUID)
+     * @param {Array<string>} [include] List of related resources to include in the response. Supported values: \&quot;customDomain\&quot;, \&quot;qrcodeDesign\&quot;, \&quot;qrcodeSignedUrl\&quot;, \&quot;tags\&quot;, \&quot;pageTheme\&quot;. Use \&quot;qrcodeSignedUrl\&quot; to fetch signed QR image URLs—they are omitted by default to keep requests fast.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceGetRaw(requestParameters: LinksServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLinkResponse>>;
+    /**
+     * Retrieves information about a shortened link including its metadata and metrics.
+     * Get link details
+     */
+    linksServiceGet(requestParameters: LinksServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLinkResponse>;
+    /**
+     * Creates request options for linksServiceGetLeadScoreExplanation without sending the request
+     * @param {string} linkId The ID of the link (UUID)
+     * @param {string} eventId The ID of the event for which to generate the explanation (UUID)
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceGetLeadScoreExplanationRequestOpts(requestParameters: LinksServiceGetLeadScoreExplanationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Generates an AI-powered explanation for a lead score result based on event data.
+     * @summary Get lead score explanation
+     * @param {string} linkId The ID of the link (UUID)
+     * @param {string} eventId The ID of the event for which to generate the explanation (UUID)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceGetLeadScoreExplanationRaw(requestParameters: LinksServiceGetLeadScoreExplanationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLeadScoreExplanationResponse>>;
+    /**
+     * Generates an AI-powered explanation for a lead score result based on event data.
+     * Get lead score explanation
+     */
+    linksServiceGetLeadScoreExplanation(requestParameters: LinksServiceGetLeadScoreExplanationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLeadScoreExplanationResponse>;
+    /**
+     * Creates request options for linksServiceList without sending the request
+     * @param {number} pageSize The maximum number of links to return.
+     * @param {string} [pageToken] The token for retrieving the next page of results If not provided, the first page of results will be returned
+     * @param {Array<string>} [include] List of related resources to include in the response. Supported values: \&quot;customDomain\&quot;, \&quot;qrcodeDesign\&quot;, \&quot;qrcodeSignedUrl\&quot;, \&quot;tags\&quot;, \&quot;pageTheme\&quot;. Use \&quot;qrcodeSignedUrl\&quot; to fetch signed QR image URLs—they are omitted by default to keep requests fast.
+     * @param {Array<string>} [tags] Tags to filter links by (matches links containing any of the provided tags)
+     * @param {string} [search] Search query to filter links by name or shortlink  Search query to filter links by name or shortlink
+     * @param {string} [sortBy] Field to sort links by (defaults to updated_at if not specified)  Field to sort links by   - LINK_SORT_FIELD_UNSPECIFIED: Sort field not specified (defaults to updated_at)  - LINK_SORT_FIELD_CREATED_AT: Sort by creation date  - LINK_SORT_FIELD_UPDATED_AT: Sort by last update date  - LINK_SORT_FIELD_SHORTLINK: Sort by shortlink name  - LINK_SORT_FIELD_NAME: Sort by link name  - LINK_SORT_FIELD_EVENT_COUNT: Sort by event count
+     * @param {string} [sortDirection] Sort direction (defaults to descending if not specified)  Sort direction (ascending or descending)   - SORT_DIRECTION_UNSPECIFIED: Sort direction not specified (defaults to descending)  - SORT_DIRECTION_ASC: Sort in ascending order  - SORT_DIRECTION_DESC: Sort in descending order
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceListRequestOpts(requestParameters: LinksServiceListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves the shortened links for your workspace
+     * @summary List links
+     * @param {number} pageSize The maximum number of links to return.
+     * @param {string} [pageToken] The token for retrieving the next page of results If not provided, the first page of results will be returned
+     * @param {Array<string>} [include] List of related resources to include in the response. Supported values: \&quot;customDomain\&quot;, \&quot;qrcodeDesign\&quot;, \&quot;qrcodeSignedUrl\&quot;, \&quot;tags\&quot;, \&quot;pageTheme\&quot;. Use \&quot;qrcodeSignedUrl\&quot; to fetch signed QR image URLs—they are omitted by default to keep requests fast.
+     * @param {Array<string>} [tags] Tags to filter links by (matches links containing any of the provided tags)
+     * @param {string} [search] Search query to filter links by name or shortlink  Search query to filter links by name or shortlink
+     * @param {string} [sortBy] Field to sort links by (defaults to updated_at if not specified)  Field to sort links by   - LINK_SORT_FIELD_UNSPECIFIED: Sort field not specified (defaults to updated_at)  - LINK_SORT_FIELD_CREATED_AT: Sort by creation date  - LINK_SORT_FIELD_UPDATED_AT: Sort by last update date  - LINK_SORT_FIELD_SHORTLINK: Sort by shortlink name  - LINK_SORT_FIELD_NAME: Sort by link name  - LINK_SORT_FIELD_EVENT_COUNT: Sort by event count
+     * @param {string} [sortDirection] Sort direction (defaults to descending if not specified)  Sort direction (ascending or descending)   - SORT_DIRECTION_UNSPECIFIED: Sort direction not specified (defaults to descending)  - SORT_DIRECTION_ASC: Sort in ascending order  - SORT_DIRECTION_DESC: Sort in descending order
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceListRaw(requestParameters: LinksServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListLinksResponse>>;
+    /**
+     * Retrieves the shortened links for your workspace
+     * List links
+     */
+    linksServiceList(requestParameters: LinksServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListLinksResponse>;
+    /**
+     * Creates request options for linksServiceShortlinkAvailability without sending the request
+     * @param {string} [shortlink] The shortlink to check availability for.
+     * @param {string} [customDomainId] The ID of the custom domain to check against (UUID) If not provided, checks against the default domain
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceShortlinkAvailabilityRequestOpts(requestParameters: LinksServiceShortlinkAvailabilityRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Checks if a shortlink is available for use to create a new link. A custom domain can be provided to check against. It typically checks the shortlink slugs and shortlink IDs already present within the system.
+     * @summary Check shortlink availability
+     * @param {string} [shortlink] The shortlink to check availability for.
+     * @param {string} [customDomainId] The ID of the custom domain to check against (UUID) If not provided, checks against the default domain
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceShortlinkAvailabilityRaw(requestParameters: LinksServiceShortlinkAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShortlinkAvailabilityResponse>>;
+    /**
+     * Checks if a shortlink is available for use to create a new link. A custom domain can be provided to check against. It typically checks the shortlink slugs and shortlink IDs already present within the system.
+     * Check shortlink availability
+     */
+    linksServiceShortlinkAvailability(requestParameters: LinksServiceShortlinkAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShortlinkAvailabilityResponse>;
+    /**
+     * Creates request options for linksServiceShortlinkRandom without sending the request
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceShortlinkRandomRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Generates a random availableshortlink for a new link.
+     * @summary Get a random shortlink
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceShortlinkRandomRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShortlinkRandomResponse>>;
+    /**
+     * Generates a random availableshortlink for a new link.
+     * Get a random shortlink
+     */
+    linksServiceShortlinkRandom(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShortlinkRandomResponse>;
+    /**
+     * Creates request options for linksServiceUpdate without sending the request
+     * @param {string} id The ID of the link to update (UUID)
+     * @param {LinksServiceUpdateBody} linksServiceUpdateBody
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceUpdateRequestOpts(requestParameters: LinksServiceUpdateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates an existing shortened link in your Linkbreakers workspace.
+     * @summary Update a link
+     * @param {string} id The ID of the link to update (UUID)
+     * @param {LinksServiceUpdateBody} linksServiceUpdateBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LinksApiInterface
+     */
+    linksServiceUpdateRaw(requestParameters: LinksServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateLinkResponse>>;
+    /**
+     * Updates an existing shortened link in your Linkbreakers workspace.
+     * Update a link
+     */
+    linksServiceUpdate(requestParameters: LinksServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateLinkResponse>;
+}
+/**
+ *
+ */
+export declare class LinksApi extends runtime.BaseAPI implements LinksApiInterface {
+    /**
+     * Creates request options for linksServiceCreate without sending the request
+     */
+    linksServiceCreateRequestOpts(requestParameters: LinksServiceCreateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * This endpoint allows users to create a new shortened URL link in their Linkbreakers workspace. The URL will be checked for malicious content before being shortened.
+     * Create a new link
+     */
+    linksServiceCreateRaw(requestParameters: LinksServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateLinkResponse>>;
+    /**
+     * This endpoint allows users to create a new shortened URL link in their Linkbreakers workspace. The URL will be checked for malicious content before being shortened.
+     * Create a new link
+     */
+    linksServiceCreate(requestParameters: LinksServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateLinkResponse>;
+    /**
+     * Creates request options for linksServiceCreateBulk without sending the request
+     */
+    linksServiceCreateBulkRequestOpts(requestParameters: LinksServiceCreateBulkRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Creates links in batch using the same per-link options as Create. This operation is transactional: if one link fails validation or insertion, no links from the batch are created.
+     * Create multiple links in a single request
+     */
+    linksServiceCreateBulkRaw(requestParameters: LinksServiceCreateBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateBulkLinksResponse>>;
+    /**
+     * Creates links in batch using the same per-link options as Create. This operation is transactional: if one link fails validation or insertion, no links from the batch are created.
+     * Create multiple links in a single request
+     */
+    linksServiceCreateBulk(requestParameters: LinksServiceCreateBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateBulkLinksResponse>;
+    /**
+     * Creates request options for linksServiceCreateContactLink without sending the request
+     */
+    linksServiceCreateContactLinkRequestOpts(requestParameters: LinksServiceCreateContactLinkRequest): Promise<runtime.RequestOpts>;
+    /**
+     * This endpoint allows users to create a new vCard contact link in their Linkbreakers workspace. The link will generate a vCard file for contact information sharing.
+     * Create a new contact card link
+     */
+    linksServiceCreateContactLinkRaw(requestParameters: LinksServiceCreateContactLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateContactLinkResponse>>;
+    /**
+     * This endpoint allows users to create a new vCard contact link in their Linkbreakers workspace. The link will generate a vCard file for contact information sharing.
+     * Create a new contact card link
+     */
+    linksServiceCreateContactLink(requestParameters: LinksServiceCreateContactLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateContactLinkResponse>;
+    /**
+     * Creates request options for linksServiceDelete without sending the request
+     */
+    linksServiceDeleteRequestOpts(requestParameters: LinksServiceDeleteRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Removes a shortened link from the workspace. This operation cannot be undone.
+     * Delete a link
+     */
+    linksServiceDeleteRaw(requestParameters: LinksServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Removes a shortened link from the workspace. This operation cannot be undone.
+     * Delete a link
+     */
+    linksServiceDelete(requestParameters: LinksServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Creates request options for linksServiceGet without sending the request
+     */
+    linksServiceGetRequestOpts(requestParameters: LinksServiceGetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves information about a shortened link including its metadata and metrics.
+     * Get link details
+     */
+    linksServiceGetRaw(requestParameters: LinksServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLinkResponse>>;
+    /**
+     * Retrieves information about a shortened link including its metadata and metrics.
+     * Get link details
+     */
+    linksServiceGet(requestParameters: LinksServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLinkResponse>;
+    /**
+     * Creates request options for linksServiceGetLeadScoreExplanation without sending the request
+     */
+    linksServiceGetLeadScoreExplanationRequestOpts(requestParameters: LinksServiceGetLeadScoreExplanationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Generates an AI-powered explanation for a lead score result based on event data.
+     * Get lead score explanation
+     */
+    linksServiceGetLeadScoreExplanationRaw(requestParameters: LinksServiceGetLeadScoreExplanationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLeadScoreExplanationResponse>>;
+    /**
+     * Generates an AI-powered explanation for a lead score result based on event data.
+     * Get lead score explanation
+     */
+    linksServiceGetLeadScoreExplanation(requestParameters: LinksServiceGetLeadScoreExplanationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLeadScoreExplanationResponse>;
+    /**
+     * Creates request options for linksServiceList without sending the request
+     */
+    linksServiceListRequestOpts(requestParameters: LinksServiceListRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves the shortened links for your workspace
+     * List links
+     */
+    linksServiceListRaw(requestParameters: LinksServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListLinksResponse>>;
+    /**
+     * Retrieves the shortened links for your workspace
+     * List links
+     */
+    linksServiceList(requestParameters: LinksServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListLinksResponse>;
+    /**
+     * Creates request options for linksServiceShortlinkAvailability without sending the request
+     */
+    linksServiceShortlinkAvailabilityRequestOpts(requestParameters: LinksServiceShortlinkAvailabilityRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Checks if a shortlink is available for use to create a new link. A custom domain can be provided to check against. It typically checks the shortlink slugs and shortlink IDs already present within the system.
+     * Check shortlink availability
+     */
+    linksServiceShortlinkAvailabilityRaw(requestParameters: LinksServiceShortlinkAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShortlinkAvailabilityResponse>>;
+    /**
+     * Checks if a shortlink is available for use to create a new link. A custom domain can be provided to check against. It typically checks the shortlink slugs and shortlink IDs already present within the system.
+     * Check shortlink availability
+     */
+    linksServiceShortlinkAvailability(requestParameters?: LinksServiceShortlinkAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShortlinkAvailabilityResponse>;
+    /**
+     * Creates request options for linksServiceShortlinkRandom without sending the request
+     */
+    linksServiceShortlinkRandomRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Generates a random availableshortlink for a new link.
+     * Get a random shortlink
+     */
+    linksServiceShortlinkRandomRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShortlinkRandomResponse>>;
+    /**
+     * Generates a random availableshortlink for a new link.
+     * Get a random shortlink
+     */
+    linksServiceShortlinkRandom(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShortlinkRandomResponse>;
+    /**
+     * Creates request options for linksServiceUpdate without sending the request
+     */
+    linksServiceUpdateRequestOpts(requestParameters: LinksServiceUpdateRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Updates an existing shortened link in your Linkbreakers workspace.
+     * Update a link
+     */
+    linksServiceUpdateRaw(requestParameters: LinksServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateLinkResponse>>;
+    /**
+     * Updates an existing shortened link in your Linkbreakers workspace.
+     * Update a link
+     */
+    linksServiceUpdate(requestParameters: LinksServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateLinkResponse>;
+}