@short.io/client-node 2.0.1 → 2.2.0

package/dist/generated/sdk.gen.d.ts

@@ -0,0 +1,474 @@
+import { type Options } from './client/index.js';
+import type { GetLinksOpengraphByDomainIdByLinkIdData, PutLinksOpengraphByDomainIdByLinkIdData, GetLinkCountryByLinkIdData, PostLinkCountryByLinkIdData, PostLinkCountryBulkByLinkIdData, DeleteLinkCountryByLinkIdByCountryData, GetLinkRegionByLinkIdData, PostLinkRegionByLinkIdData, GetLinkRegionListByCountryData, PostLinkRegionBulkByLinkIdData, DeleteLinkRegionByLinkIdByCountryByRegionData, GetLinksPermissionsByDomainIdByLinkIdData, DeleteLinksPermissionsByDomainIdByLinkIdByUserIdData, DeleteLinksPermissionsByDomainIdByLinkIdByUserIdError, PostLinksPermissionsByDomainIdByLinkIdByUserIdData, PostLinksPermissionsByDomainIdByLinkIdByUserIdError, GetApiLinksData, PostLinksQrByLinkIdStringData, PostLinksQrBulkData, DeleteLinksByLinkIdData, DeleteLinksDeleteBulkData, PostLinksArchiveData, PostLinksArchiveBulkData, PostLinksUnarchiveData, PostLinksUnarchiveBulkData, GetLinksByLinkIdData, PostLinksByLinkIdData, PostLinksByLinkIdError, GetLinksExpandData, GetLinksByOriginalUrlData, GetLinksMultipleByUrlData, PostLinksData, GetLinksTweetbotData, PostLinksPublicData, PostLinksBulkData, GetApiDomainsData, GetDomainsByDomainIdData, PostDomainsData, PostDomainsError, PostDomainsSettingsByDomainIdData, PostTagsBulkData, GetLinksFoldersByDomainIdData, GetLinksFoldersByDomainIdByFolderIdData, PostLinksFoldersData } from './types.gen.js';
+export declare const client: import("./client/index.js").Client<Request, Response, unknown, import("./client/types.js").RequestOptions>;
+export declare const getLinksOpengraphByDomainIdByLinkId: <ThrowOnError extends boolean = false>(options: Options<GetLinksOpengraphByDomainIdByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const putLinksOpengraphByDomainIdByLinkId: <ThrowOnError extends boolean = false>(options: Options<PutLinksOpengraphByDomainIdByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const getLinkCountryByLinkId: <ThrowOnError extends boolean = false>(options: Options<GetLinkCountryByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const postLinkCountryByLinkId: <ThrowOnError extends boolean = false>(options: Options<PostLinkCountryByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const postLinkCountryBulkByLinkId: <ThrowOnError extends boolean = false>(options: Options<PostLinkCountryBulkByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const deleteLinkCountryByLinkIdByCountry: <ThrowOnError extends boolean = false>(options: Options<DeleteLinkCountryByLinkIdByCountryData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const getLinkRegionByLinkId: <ThrowOnError extends boolean = false>(options: Options<GetLinkRegionByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const postLinkRegionByLinkId: <ThrowOnError extends boolean = false>(options: Options<PostLinkRegionByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const getLinkRegionListByCountry: <ThrowOnError extends boolean = false>(options: Options<GetLinkRegionListByCountryData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const postLinkRegionBulkByLinkId: <ThrowOnError extends boolean = false>(options: Options<PostLinkRegionBulkByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const deleteLinkRegionByLinkIdByCountryByRegion: <ThrowOnError extends boolean = false>(options: Options<DeleteLinkRegionByLinkIdByCountryByRegionData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const getLinksPermissionsByDomainIdByLinkId: <ThrowOnError extends boolean = false>(options: Options<GetLinksPermissionsByDomainIdByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    id: string;
+    DomainId: number;
+    UserId: number;
+    LinkIdString: string;
+}[], {
+    error: string;
+}, ThrowOnError>;
+export declare const deleteLinksPermissionsByDomainIdByLinkIdByUserId: <ThrowOnError extends boolean = false>(options: Options<DeleteLinksPermissionsByDomainIdByLinkIdByUserIdData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    success: boolean;
+}, DeleteLinksPermissionsByDomainIdByLinkIdByUserIdError, ThrowOnError>;
+export declare const postLinksPermissionsByDomainIdByLinkIdByUserId: <ThrowOnError extends boolean = false>(options: Options<PostLinksPermissionsByDomainIdByLinkIdByUserIdData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    id: string;
+    DomainId: number;
+    UserId: number;
+    LinkIdString: string;
+}, PostLinksPermissionsByDomainIdByLinkIdByUserIdError, ThrowOnError>;
+export declare const getApiLinks: <ThrowOnError extends boolean = false>(options: Options<GetApiLinksData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    count: number;
+    links: Array<{
+        originalURL: string;
+        cloaking?: boolean;
+        password?: string;
+        expiresAt?: number | string;
+        expiredURL?: string;
+        title?: string;
+        tags?: Array<string>;
+        utmSource?: string;
+        utmMedium?: string;
+        utmCampaign?: string;
+        utmTerm?: string;
+        utmContent?: string;
+        ttl?: string | number;
+        path: string;
+        androidURL?: string;
+        iphoneURL?: string;
+        createdAt?: number | string;
+        clicksLimit?: number;
+        passwordContact?: boolean;
+        skipQS?: boolean;
+        archived?: boolean;
+        splitURL?: string;
+        splitPercent?: number;
+        integrationAdroll?: string;
+        integrationFB?: string;
+        integrationGA?: string;
+        integrationGTM?: string;
+        idString: string;
+        id: string;
+        shortURL: string;
+        secureShortURL: string;
+        redirectType?: "301" | "302" | "307" | "308";
+        FolderId?: string;
+        DomainId?: number;
+        OwnerId?: number;
+        hasPassword?: boolean;
+        source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
+        User?: {
+            id: number;
+            name: string;
+            email: string;
+            photoURL: string;
+        };
+    }>;
+    nextPageToken?: string;
+}, {
+    error: string;
+}, ThrowOnError>;
+export declare const postLinksQrByLinkIdString: <ThrowOnError extends boolean = false>(options: Options<PostLinksQrByLinkIdStringData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const postLinksQrBulk: <ThrowOnError extends boolean = false>(options: Options<PostLinksQrBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<Blob | File, unknown, ThrowOnError>;
+export declare const deleteLinksByLinkId: <ThrowOnError extends boolean = false>(options: Options<DeleteLinksByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    success: boolean;
+    idString?: string;
+    error?: string;
+}, unknown, ThrowOnError>;
+export declare const deleteLinksDeleteBulk: <ThrowOnError extends boolean = false>(options: Options<DeleteLinksDeleteBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    success: boolean;
+    error?: string;
+}, unknown, ThrowOnError>;
+export declare const postLinksArchive: <ThrowOnError extends boolean = false>(options: Options<PostLinksArchiveData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    success: boolean;
+    error?: string;
+}, {
+    error: string;
+    message?: string;
+}, ThrowOnError>;
+export declare const postLinksArchiveBulk: <ThrowOnError extends boolean = false>(options: Options<PostLinksArchiveBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    success: boolean;
+    error?: string;
+}, {
+    error: string;
+    message?: string;
+}, ThrowOnError>;
+export declare const postLinksUnarchive: <ThrowOnError extends boolean = false>(options: Options<PostLinksUnarchiveData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    success: boolean;
+    error?: string;
+}, {
+    error: string;
+    message?: string;
+}, ThrowOnError>;
+export declare const postLinksUnarchiveBulk: <ThrowOnError extends boolean = false>(options: Options<PostLinksUnarchiveBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    success: boolean;
+    error?: string;
+}, {
+    error: string;
+    message?: string;
+}, ThrowOnError>;
+export declare const getLinksByLinkId: <ThrowOnError extends boolean = false>(options: Options<GetLinksByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    originalURL: string;
+    cloaking?: boolean;
+    password?: string;
+    expiresAt?: number | string;
+    expiredURL?: string;
+    title?: string;
+    tags?: Array<string>;
+    utmSource?: string;
+    utmMedium?: string;
+    utmCampaign?: string;
+    utmTerm?: string;
+    utmContent?: string;
+    ttl?: string | number;
+    path: string;
+    androidURL?: string;
+    iphoneURL?: string;
+    createdAt?: number | string;
+    clicksLimit?: number;
+    passwordContact?: boolean;
+    skipQS?: boolean;
+    archived?: boolean;
+    splitURL?: string;
+    splitPercent?: number;
+    integrationAdroll?: string;
+    integrationFB?: string;
+    integrationGA?: string;
+    integrationGTM?: string;
+    idString: string;
+    id: string;
+    shortURL: string;
+    secureShortURL: string;
+    redirectType?: "301" | "302" | "307" | "308";
+    FolderId?: string;
+    DomainId?: number;
+    OwnerId?: number;
+    hasPassword?: boolean;
+    source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
+    User?: {
+        id: number;
+        name: string;
+        email: string;
+        photoURL: string;
+    };
+}, {
+    error: string;
+}, ThrowOnError>;
+export declare const postLinksByLinkId: <ThrowOnError extends boolean = false>(options: Options<PostLinksByLinkIdData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    originalURL: string;
+    cloaking?: boolean;
+    password?: string;
+    expiresAt?: number | string;
+    expiredURL?: string;
+    title?: string;
+    tags?: Array<string>;
+    utmSource?: string;
+    utmMedium?: string;
+    utmCampaign?: string;
+    utmTerm?: string;
+    utmContent?: string;
+    ttl?: string | number;
+    path: string;
+    androidURL?: string;
+    iphoneURL?: string;
+    createdAt?: number | string;
+    clicksLimit?: number;
+    passwordContact?: boolean;
+    skipQS?: boolean;
+    archived?: boolean;
+    splitURL?: string;
+    splitPercent?: number;
+    integrationAdroll?: string;
+    integrationFB?: string;
+    integrationGA?: string;
+    integrationGTM?: string;
+    idString: string;
+    id: string;
+    shortURL: string;
+    secureShortURL: string;
+    redirectType?: "301" | "302" | "307" | "308";
+    FolderId?: string;
+    DomainId?: number;
+    OwnerId?: number;
+    hasPassword?: boolean;
+    source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
+    User?: {
+        id: number;
+        name: string;
+        email: string;
+        photoURL: string;
+    };
+}, PostLinksByLinkIdError, ThrowOnError>;
+export declare const getLinksExpand: <ThrowOnError extends boolean = false>(options: Options<GetLinksExpandData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    originalURL: string;
+    cloaking?: boolean;
+    password?: string;
+    expiresAt?: number | string;
+    expiredURL?: string;
+    title?: string;
+    tags?: Array<string>;
+    utmSource?: string;
+    utmMedium?: string;
+    utmCampaign?: string;
+    utmTerm?: string;
+    utmContent?: string;
+    ttl?: string | number;
+    path: string;
+    androidURL?: string;
+    iphoneURL?: string;
+    createdAt?: number | string;
+    clicksLimit?: number;
+    passwordContact?: boolean;
+    skipQS?: boolean;
+    archived?: boolean;
+    splitURL?: string;
+    splitPercent?: number;
+    integrationAdroll?: string;
+    integrationFB?: string;
+    integrationGA?: string;
+    integrationGTM?: string;
+    idString: string;
+    id: string;
+    shortURL: string;
+    secureShortURL: string;
+    redirectType?: "301" | "302" | "307" | "308";
+    FolderId?: string;
+    DomainId?: number;
+    OwnerId?: number;
+    hasPassword?: boolean;
+    source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
+    User?: {
+        id: number;
+        name: string;
+        email: string;
+        photoURL: string;
+    };
+}, {
+    error: string;
+}, ThrowOnError>;
+export declare const getLinksByOriginalUrl: <ThrowOnError extends boolean = false>(options: Options<GetLinksByOriginalUrlData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const getLinksMultipleByUrl: <ThrowOnError extends boolean = false>(options: Options<GetLinksMultipleByUrlData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const postLinks: <ThrowOnError extends boolean = false>(options: Options<PostLinksData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    originalURL: string;
+    cloaking?: boolean;
+    password?: string;
+    expiresAt?: number | string;
+    expiredURL?: string;
+    title?: string;
+    tags?: Array<string>;
+    utmSource?: string;
+    utmMedium?: string;
+    utmCampaign?: string;
+    utmTerm?: string;
+    utmContent?: string;
+    ttl?: string | number;
+    path: string;
+    androidURL?: string;
+    iphoneURL?: string;
+    createdAt?: number | string;
+    clicksLimit?: number;
+    passwordContact?: boolean;
+    skipQS?: boolean;
+    archived?: boolean;
+    splitURL?: string;
+    splitPercent?: number;
+    integrationAdroll?: string;
+    integrationFB?: string;
+    integrationGA?: string;
+    integrationGTM?: string;
+    idString: string;
+    id: string;
+    shortURL: string;
+    secureShortURL: string;
+    redirectType?: "301" | "302" | "307" | "308";
+    FolderId?: string;
+    DomainId?: number;
+    OwnerId?: number;
+    hasPassword?: boolean;
+    source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
+    User?: {
+        id: number;
+        name: string;
+        email: string;
+        photoURL: string;
+    };
+    success?: boolean;
+    duplicate?: boolean;
+}, {
+    code?: string;
+    message: string;
+    success?: boolean;
+    statusCode: number;
+}, ThrowOnError>;
+export declare const getLinksTweetbot: <ThrowOnError extends boolean = false>(options: Options<GetLinksTweetbotData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const postLinksPublic: <ThrowOnError extends boolean = false>(options: Options<PostLinksPublicData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    originalURL: string;
+    cloaking?: boolean;
+    password?: string;
+    expiresAt?: number | string;
+    expiredURL?: string;
+    title?: string;
+    tags?: Array<string>;
+    utmSource?: string;
+    utmMedium?: string;
+    utmCampaign?: string;
+    utmTerm?: string;
+    utmContent?: string;
+    ttl?: string | number;
+    path: string;
+    androidURL?: string;
+    iphoneURL?: string;
+    createdAt?: number | string;
+    clicksLimit?: number;
+    passwordContact?: boolean;
+    skipQS?: boolean;
+    archived?: boolean;
+    splitURL?: string;
+    splitPercent?: number;
+    integrationAdroll?: string;
+    integrationFB?: string;
+    integrationGA?: string;
+    integrationGTM?: string;
+    idString: string;
+    id: string;
+    shortURL: string;
+    secureShortURL: string;
+    redirectType?: "301" | "302" | "307" | "308";
+    FolderId?: string;
+    DomainId?: number;
+    OwnerId?: number;
+    hasPassword?: boolean;
+    source?: "website" | "api" | "public" | "spreadsheets" | "slack" | "telegram";
+    User?: {
+        id: number;
+        name: string;
+        email: string;
+        photoURL: string;
+    };
+    success?: boolean;
+    duplicate?: boolean;
+}, {
+    code?: string;
+    message: string;
+    success?: boolean;
+    statusCode: number;
+}, ThrowOnError>;
+export declare const postLinksBulk: <ThrowOnError extends boolean = false>(options: Options<PostLinksBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const getApiDomains: <ThrowOnError extends boolean = false>(options?: Options<GetApiDomainsData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    id: number;
+    hostname: string;
+    unicodeHostname: string;
+    state: "extra_records" | "not_registered" | "configured" | "not_configured" | "registration_pending" | "not_verified";
+    createdAt: string;
+    updatedAt: string;
+    TeamId?: number;
+    hasFavicon: boolean;
+    segmentKey?: string;
+    hideReferer: boolean;
+    linkType: "increment" | "random" | "secure" | "four-char" | "eight-char" | "ten-char";
+    cloaking: boolean;
+    hideVisitorIp: boolean;
+    enableAI: boolean;
+    httpsLevel: "none" | "redirect" | "hsts";
+    httpsLinks: boolean;
+    webhookURL?: string;
+    integrationGA?: string;
+    integrationFB?: string;
+    integrationAdroll?: string;
+    integrationGTM?: string;
+    clientStorage: {};
+    caseSensitive: boolean;
+    incrementCounter: string;
+    robots: "allow" | "disallow" | "noindex";
+    sslCertExpirationDate?: string;
+    sslCertInstalledSuccess?: boolean;
+    domainRegistrationId?: number;
+    UserId?: number;
+    exportEnabled: boolean;
+    isFavorite: boolean;
+}[], unknown, ThrowOnError>;
+export declare const getDomainsByDomainId: <ThrowOnError extends boolean = false>(options: Options<GetDomainsByDomainIdData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    id: number;
+    hostname: string;
+    unicodeHostname: string;
+    state: "extra_records" | "not_registered" | "configured" | "not_configured" | "registration_pending" | "not_verified";
+    createdAt: string;
+    updatedAt: string;
+    TeamId?: number;
+    hasFavicon: boolean;
+    segmentKey?: string;
+    hideReferer: boolean;
+    linkType: "increment" | "random" | "secure" | "four-char" | "eight-char" | "ten-char";
+    cloaking: boolean;
+    hideVisitorIp: boolean;
+    enableAI: boolean;
+    httpsLevel: "none" | "redirect" | "hsts";
+    httpsLinks: boolean;
+    webhookURL?: string;
+    integrationGA?: string;
+    integrationFB?: string;
+    integrationAdroll?: string;
+    integrationGTM?: string;
+    clientStorage: {};
+    caseSensitive: boolean;
+    incrementCounter: string;
+    robots: "allow" | "disallow" | "noindex";
+    sslCertExpirationDate?: string;
+    sslCertInstalledSuccess?: boolean;
+    domainRegistrationId?: number;
+    UserId?: number;
+    exportEnabled: boolean;
+    ipExclusions: Array<string>;
+    userPlan: "tiny" | "hobby" | "small" | "standard" | "large";
+}, {
+    error: string;
+}, ThrowOnError>;
+export declare const postDomains: <ThrowOnError extends boolean = false>(options: Options<PostDomainsData, ThrowOnError>) => import("./client/index.js").RequestResult<{
+    id: number;
+    hostname: string;
+    unicodeHostname: string;
+    state: "extra_records" | "not_registered" | "configured" | "not_configured" | "registration_pending" | "not_verified";
+    createdAt: string;
+    updatedAt: string;
+    TeamId?: number;
+    hasFavicon: boolean;
+    segmentKey?: string;
+    hideReferer: boolean;
+    linkType: "increment" | "random" | "secure" | "four-char" | "eight-char" | "ten-char";
+    cloaking: boolean;
+    hideVisitorIp: boolean;
+    enableAI: boolean;
+    httpsLevel: "none" | "redirect" | "hsts";
+    httpsLinks: boolean;
+    webhookURL?: string;
+    integrationGA?: string;
+    integrationFB?: string;
+    integrationAdroll?: string;
+    integrationGTM?: string;
+    clientStorage: {};
+    caseSensitive: boolean;
+    incrementCounter: string;
+    robots: "allow" | "disallow" | "noindex";
+    sslCertExpirationDate?: string;
+    sslCertInstalledSuccess?: boolean;
+    domainRegistrationId?: number;
+    UserId?: number;
+    exportEnabled: boolean;
+}, PostDomainsError, ThrowOnError>;
+export declare const postDomainsSettingsByDomainId: <ThrowOnError extends boolean = false>(options: Options<PostDomainsSettingsByDomainIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const postTagsBulk: <ThrowOnError extends boolean = false>(options: Options<PostTagsBulkData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const getLinksFoldersByDomainId: <ThrowOnError extends boolean = false>(options: Options<GetLinksFoldersByDomainIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const getLinksFoldersByDomainIdByFolderId: <ThrowOnError extends boolean = false>(options: Options<GetLinksFoldersByDomainIdByFolderIdData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;
+export declare const postLinksFolders: <ThrowOnError extends boolean = false>(options: Options<PostLinksFoldersData, ThrowOnError>) => import("./client/index.js").RequestResult<unknown, unknown, ThrowOnError>;