linkbreakers 1.34.0

package/dist/apis/LinksApi.js

@@ -0,0 +1,510 @@
+"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.LinksApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class LinksApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for linksServiceCreate without sending the request
+     */
+    async linksServiceCreateRequestOpts(requestParameters) {
+        if (requestParameters['createLinkRequest'] == null) {
+            throw new runtime.RequiredError('createLinkRequest', 'Required parameter "createLinkRequest" was null or undefined when calling linksServiceCreate().');
+        }
+        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/links`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.CreateLinkRequestToJSON)(requestParameters['createLinkRequest']),
+        };
+    }
+    /**
+     * 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
+     */
+    async linksServiceCreateRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.linksServiceCreateRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateLinkResponseFromJSON)(jsonValue));
+    }
+    /**
+     * 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
+     */
+    async linksServiceCreate(requestParameters, initOverrides) {
+        const response = await this.linksServiceCreateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for linksServiceCreateBulk without sending the request
+     */
+    async linksServiceCreateBulkRequestOpts(requestParameters) {
+        if (requestParameters['createBulkLinksRequest'] == null) {
+            throw new runtime.RequiredError('createBulkLinksRequest', 'Required parameter "createBulkLinksRequest" was null or undefined when calling linksServiceCreateBulk().');
+        }
+        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/links/bulk`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.CreateBulkLinksRequestToJSON)(requestParameters['createBulkLinksRequest']),
+        };
+    }
+    /**
+     * 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
+     */
+    async linksServiceCreateBulkRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.linksServiceCreateBulkRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateBulkLinksResponseFromJSON)(jsonValue));
+    }
+    /**
+     * 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
+     */
+    async linksServiceCreateBulk(requestParameters, initOverrides) {
+        const response = await this.linksServiceCreateBulkRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for linksServiceCreateContactLink without sending the request
+     */
+    async linksServiceCreateContactLinkRequestOpts(requestParameters) {
+        if (requestParameters['createContactLinkRequest'] == null) {
+            throw new runtime.RequiredError('createContactLinkRequest', 'Required parameter "createContactLinkRequest" was null or undefined when calling linksServiceCreateContactLink().');
+        }
+        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/links/contact`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.CreateContactLinkRequestToJSON)(requestParameters['createContactLinkRequest']),
+        };
+    }
+    /**
+     * 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
+     */
+    async linksServiceCreateContactLinkRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.linksServiceCreateContactLinkRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateContactLinkResponseFromJSON)(jsonValue));
+    }
+    /**
+     * 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
+     */
+    async linksServiceCreateContactLink(requestParameters, initOverrides) {
+        const response = await this.linksServiceCreateContactLinkRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for linksServiceDelete without sending the request
+     */
+    async linksServiceDeleteRequestOpts(requestParameters) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling linksServiceDelete().');
+        }
+        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/links/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Removes a shortened link from the workspace. This operation cannot be undone.
+     * Delete a link
+     */
+    async linksServiceDeleteRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.linksServiceDeleteRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response);
+    }
+    /**
+     * Removes a shortened link from the workspace. This operation cannot be undone.
+     * Delete a link
+     */
+    async linksServiceDelete(requestParameters, initOverrides) {
+        const response = await this.linksServiceDeleteRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for linksServiceGet without sending the request
+     */
+    async linksServiceGetRequestOpts(requestParameters) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling linksServiceGet().');
+        }
+        const queryParameters = {};
+        if (requestParameters['include'] != null) {
+            queryParameters['include'] = requestParameters['include'];
+        }
+        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/links/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves information about a shortened link including its metadata and metrics.
+     * Get link details
+     */
+    async linksServiceGetRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.linksServiceGetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetLinkResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Retrieves information about a shortened link including its metadata and metrics.
+     * Get link details
+     */
+    async linksServiceGet(requestParameters, initOverrides) {
+        const response = await this.linksServiceGetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for linksServiceGetLeadScoreExplanation without sending the request
+     */
+    async linksServiceGetLeadScoreExplanationRequestOpts(requestParameters) {
+        if (requestParameters['linkId'] == null) {
+            throw new runtime.RequiredError('linkId', 'Required parameter "linkId" was null or undefined when calling linksServiceGetLeadScoreExplanation().');
+        }
+        if (requestParameters['eventId'] == null) {
+            throw new runtime.RequiredError('eventId', 'Required parameter "eventId" was null or undefined when calling linksServiceGetLeadScoreExplanation().');
+        }
+        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/links/{linkId}/lead-score-explanation/{eventId}`;
+        urlPath = urlPath.replace(`{${"linkId"}}`, encodeURIComponent(String(requestParameters['linkId'])));
+        urlPath = urlPath.replace(`{${"eventId"}}`, encodeURIComponent(String(requestParameters['eventId'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Generates an AI-powered explanation for a lead score result based on event data.
+     * Get lead score explanation
+     */
+    async linksServiceGetLeadScoreExplanationRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.linksServiceGetLeadScoreExplanationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetLeadScoreExplanationResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Generates an AI-powered explanation for a lead score result based on event data.
+     * Get lead score explanation
+     */
+    async linksServiceGetLeadScoreExplanation(requestParameters, initOverrides) {
+        const response = await this.linksServiceGetLeadScoreExplanationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for linksServiceList without sending the request
+     */
+    async linksServiceListRequestOpts(requestParameters) {
+        if (requestParameters['pageSize'] == null) {
+            throw new runtime.RequiredError('pageSize', 'Required parameter "pageSize" was null or undefined when calling linksServiceList().');
+        }
+        const queryParameters = {};
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+        if (requestParameters['pageToken'] != null) {
+            queryParameters['pageToken'] = requestParameters['pageToken'];
+        }
+        if (requestParameters['include'] != null) {
+            queryParameters['include'] = requestParameters['include'];
+        }
+        if (requestParameters['tags'] != null) {
+            queryParameters['tags'] = requestParameters['tags'];
+        }
+        if (requestParameters['search'] != null) {
+            queryParameters['search'] = requestParameters['search'];
+        }
+        if (requestParameters['sortBy'] != null) {
+            queryParameters['sortBy'] = requestParameters['sortBy'];
+        }
+        if (requestParameters['sortDirection'] != null) {
+            queryParameters['sortDirection'] = requestParameters['sortDirection'];
+        }
+        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/links`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves the shortened links for your workspace
+     * List links
+     */
+    async linksServiceListRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.linksServiceListRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListLinksResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Retrieves the shortened links for your workspace
+     * List links
+     */
+    async linksServiceList(requestParameters, initOverrides) {
+        const response = await this.linksServiceListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for linksServiceShortlinkAvailability without sending the request
+     */
+    async linksServiceShortlinkAvailabilityRequestOpts(requestParameters) {
+        const queryParameters = {};
+        if (requestParameters['shortlink'] != null) {
+            queryParameters['shortlink'] = requestParameters['shortlink'];
+        }
+        if (requestParameters['customDomainId'] != null) {
+            queryParameters['customDomainId'] = requestParameters['customDomainId'];
+        }
+        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/links/shortlink-availability`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * 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
+     */
+    async linksServiceShortlinkAvailabilityRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.linksServiceShortlinkAvailabilityRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ShortlinkAvailabilityResponseFromJSON)(jsonValue));
+    }
+    /**
+     * 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
+     */
+    async linksServiceShortlinkAvailability(requestParameters = {}, initOverrides) {
+        const response = await this.linksServiceShortlinkAvailabilityRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for linksServiceShortlinkRandom without sending the request
+     */
+    async linksServiceShortlinkRandomRequestOpts() {
+        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/links/shortlink-random`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Generates a random availableshortlink for a new link.
+     * Get a random shortlink
+     */
+    async linksServiceShortlinkRandomRaw(initOverrides) {
+        const requestOptions = await this.linksServiceShortlinkRandomRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ShortlinkRandomResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Generates a random availableshortlink for a new link.
+     * Get a random shortlink
+     */
+    async linksServiceShortlinkRandom(initOverrides) {
+        const response = await this.linksServiceShortlinkRandomRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for linksServiceUpdate without sending the request
+     */
+    async linksServiceUpdateRequestOpts(requestParameters) {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling linksServiceUpdate().');
+        }
+        if (requestParameters['linksServiceUpdateBody'] == null) {
+            throw new runtime.RequiredError('linksServiceUpdateBody', 'Required parameter "linksServiceUpdateBody" was null or undefined when calling linksServiceUpdate().');
+        }
+        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/links/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+        return {
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.LinksServiceUpdateBodyToJSON)(requestParameters['linksServiceUpdateBody']),
+        };
+    }
+    /**
+     * Updates an existing shortened link in your Linkbreakers workspace.
+     * Update a link
+     */
+    async linksServiceUpdateRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.linksServiceUpdateRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UpdateLinkResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Updates an existing shortened link in your Linkbreakers workspace.
+     * Update a link
+     */
+    async linksServiceUpdate(requestParameters, initOverrides) {
+        const response = await this.linksServiceUpdateRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+exports.LinksApi = LinksApi;