@mittwald/api-client 4.147.1 → 4.149.0

package/dist/esm/generated/v2/client-react.js

@@ -249,6 +249,22 @@ const buildFileApi = (baseClient) => ({
     /** Get a File with user-friendly url. */
     getFileWithName: new ApiCallAsyncResourceFactory(descriptors.fileGetFileWithName, baseClient.file.getFileWithName).getApiResource,
 });
+const buildLeadFyndrApi = (baseClient) => ({
+    /** Get your LeadFyndr request. */
+    leadfyndrGetLeadFyndrProfileRequestExperimental: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetLeadFyndrProfileRequestExperimental, baseClient.leadFyndr.leadfyndrGetLeadFyndrProfileRequestExperimental).getApiResource,
+    /** Get a simple lead. Use the unlocked route for more detail leads. */
+    leadfyndrGetLeadExperimental: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetLeadExperimental, baseClient.leadFyndr.leadfyndrGetLeadExperimental).getApiResource,
+    /** Get your LeadFyndr profile. */
+    leadfyndrGetLeadFyndrProfileExperimental: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetLeadFyndrProfileExperimental, baseClient.leadFyndr.leadfyndrGetLeadFyndrProfileExperimental).getApiResource,
+    /** Get lead tariff options. How many leads did you unlock this month? */
+    leadfyndrGetLeadFyndrProfileTariffOptionsExperimental: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetLeadFyndrProfileTariffOptionsExperimental, baseClient.leadFyndr.leadfyndrGetLeadFyndrProfileTariffOptionsExperimental).getApiResource,
+    /** Get a detail of a unlocked lead. Organisation can unlock leads. */
+    leadfyndrGetUnlockedLeadExperimental: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetUnlockedLeadExperimental, baseClient.leadFyndr.leadfyndrGetUnlockedLeadExperimental).getApiResource,
+    /** Get all leads. Use the unlocked routes for more lead details. */
+    leadfyndrListLeadsExperimental: new ApiCallAsyncResourceFactory(descriptors.leadfyndrListLeadsExperimental, baseClient.leadFyndr.leadfyndrListLeadsExperimental).getApiResource,
+    /** Get all unlocked leads. Organisation can unlock leads. */
+    leadfyndrListUnlockedLeadsExperimental: new ApiCallAsyncResourceFactory(descriptors.leadfyndrListUnlockedLeadsExperimental, baseClient.leadFyndr.leadfyndrListUnlockedLeadsExperimental).getApiResource,
+});
 const buildMailApi = (baseClient) => ({
     /** List DeliveryBoxes belonging to a Project. */
     listDeliveryBoxes: new ApiCallAsyncResourceFactory(descriptors.mailListDeliveryBoxes, baseClient.mail.listDeliveryBoxes).getApiResource,
@@ -388,6 +404,8 @@ export class MittwaldAPIV2ClientReact {
     marketplace;
     /** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
     file;
+    /** The lead fyndr api allow you to manage you leads and your fyndr profile. */
+    leadFyndr;
     /** The mail API allows you to manage your mail accounts. */
     mail;
     /** The notification API allows you to manage your notifications. */
@@ -415,6 +433,7 @@ export class MittwaldAPIV2ClientReact {
         this.domain = buildDomainApi(baseClient);
         this.marketplace = buildMarketplaceApi(baseClient);
         this.file = buildFileApi(baseClient);
+        this.leadFyndr = buildLeadFyndrApi(baseClient);
         this.mail = buildMailApi(baseClient);
         this.notification = buildNotificationApi(baseClient);
         this.pageInsights = buildPageInsightsApi(baseClient);

package/dist/esm/generated/v2/client.js

@@ -693,6 +693,31 @@ export class MittwaldAPIV2Client extends ApiClientBase {
         /** Get a File with user-friendly url. */
         getFileWithName: this.requestFunctionFactory(descriptors.fileGetFileWithName),
     };
+    /** The lead fyndr api allow you to manage you leads and your fyndr profile. */
+    leadFyndr = {
+        /** Get your LeadFyndr request. */
+        leadfyndrGetLeadFyndrProfileRequestExperimental: this.requestFunctionFactory(descriptors.leadfyndrGetLeadFyndrProfileRequestExperimental),
+        /** Create a new access request for LeadFyndr. */
+        leadfyndrCreateLeadFyndrAccessRequestExperimental: this.requestFunctionFactory(descriptors.leadfyndrCreateLeadFyndrAccessRequestExperimental),
+        /** Get a simple lead. Use the unlocked route for more detail leads. */
+        leadfyndrGetLeadExperimental: this.requestFunctionFactory(descriptors.leadfyndrGetLeadExperimental),
+        /** Get your LeadFyndr profile. */
+        leadfyndrGetLeadFyndrProfileExperimental: this.requestFunctionFactory(descriptors.leadfyndrGetLeadFyndrProfileExperimental),
+        /** Get lead tariff options. How many leads did you unlock this month? */
+        leadfyndrGetLeadFyndrProfileTariffOptionsExperimental: this.requestFunctionFactory(descriptors.leadfyndrGetLeadFyndrProfileTariffOptionsExperimental),
+        /** Get a detail of a unlocked lead. Organisation can unlock leads. */
+        leadfyndrGetUnlockedLeadExperimental: this.requestFunctionFactory(descriptors.leadfyndrGetUnlockedLeadExperimental),
+        /** Unlock a lead for the given customerId. */
+        leadfyndrUnlockLeadExperimental: this.requestFunctionFactory(descriptors.leadfyndrUnlockLeadExperimental),
+        /** Get all leads. Use the unlocked routes for more lead details. */
+        leadfyndrListLeadsExperimental: this.requestFunctionFactory(descriptors.leadfyndrListLeadsExperimental),
+        /** Get all unlocked leads. Organisation can unlock leads. */
+        leadfyndrListUnlockedLeadsExperimental: this.requestFunctionFactory(descriptors.leadfyndrListUnlockedLeadsExperimental),
+        /** Reserve a unlocked lead for the given customerId. */
+        leadfyndrReserveUnlockedLeadExperimental: this.requestFunctionFactory(descriptors.leadfyndrReserveUnlockedLeadExperimental),
+        /** Removes a reservation on a unlocked lead for the given customerId. */
+        leadfyndrRemoveUnlockedLeadReservationExperimental: this.requestFunctionFactory(descriptors.leadfyndrRemoveUnlockedLeadReservationExperimental),
+    };
     /** The page insights API allows you to get page insights information. */
     pageInsights = {
         /** Get detailed performance data for a given domain and path. */

package/dist/esm/generated/v2/descriptors.js

@@ -1390,6 +1390,72 @@ export const invoiceListCustomerInvoices = {
     method: "GET",
     operationId: "invoice-list-customer-invoices",
 };
+/** Get your LeadFyndr request. */
+export const leadfyndrGetLeadFyndrProfileRequestExperimental = {
+    path: "/v2-experimental/customers/{customerId}/lead-fyndr-profile-request",
+    method: "GET",
+    operationId: "leadfyndr-get-lead-fyndr-profile-request-experimental",
+};
+/** Create a new access request for LeadFyndr. */
+export const leadfyndrCreateLeadFyndrAccessRequestExperimental = {
+    path: "/v2-experimental/customers/{customerId}/lead-fyndr-profile-request",
+    method: "POST",
+    operationId: "leadfyndr-create-lead-fyndr-access-request-experimental",
+};
+/** Get a simple lead. Use the unlocked route for more detail leads. */
+export const leadfyndrGetLeadExperimental = {
+    path: "/v2-experimental/customers/{customerId}/leads/{leadId}",
+    method: "GET",
+    operationId: "leadfyndr-get-lead-experimental",
+};
+/** Get your LeadFyndr profile. */
+export const leadfyndrGetLeadFyndrProfileExperimental = {
+    path: "/v2-experimental/customers/{customerId}/lead-fyndr-profile",
+    method: "GET",
+    operationId: "leadfyndr-get-lead-fyndr-profile-experimental",
+};
+/** Get lead tariff options. How many leads did you unlock this month? */
+export const leadfyndrGetLeadFyndrProfileTariffOptionsExperimental = {
+    path: "/v2-experimental/customers/{customerId}/lead-fyndr-profile/tariff",
+    method: "GET",
+    operationId: "leadfyndr-get-lead-fyndr-profile-tariff-options-experimental",
+};
+/** Get a detail of a unlocked lead. Organisation can unlock leads. */
+export const leadfyndrGetUnlockedLeadExperimental = {
+    path: "/v2-experimental/customers/{customerId}/unlocked-leads/{leadId}",
+    method: "GET",
+    operationId: "leadfyndr-get-unlocked-lead-experimental",
+};
+/** Unlock a lead for the given customerId. */
+export const leadfyndrUnlockLeadExperimental = {
+    path: "/v2-experimental/customers/{customerId}/unlocked-leads/{leadId}",
+    method: "POST",
+    operationId: "leadfyndr-unlock-lead-experimental",
+};
+/** Get all leads. Use the unlocked routes for more lead details. */
+export const leadfyndrListLeadsExperimental = {
+    path: "/v2-experimental/customers/{customerId}/leads",
+    method: "GET",
+    operationId: "leadfyndr-list-leads-experimental",
+};
+/** Get all unlocked leads. Organisation can unlock leads. */
+export const leadfyndrListUnlockedLeadsExperimental = {
+    path: "/v2-experimental/customers/{customerId}/unlocked-leads",
+    method: "GET",
+    operationId: "leadfyndr-list-unlocked-leads-experimental",
+};
+/** Reserve a unlocked lead for the given customerId. */
+export const leadfyndrReserveUnlockedLeadExperimental = {
+    path: "/v2-experimental/customers/{customerId}/unlocked-leads/{leadId}/reservation",
+    method: "POST",
+    operationId: "leadfyndr-reserve-unlocked-lead-experimental",
+};
+/** Removes a reservation on a unlocked lead for the given customerId. */
+export const leadfyndrRemoveUnlockedLeadReservationExperimental = {
+    path: "/v2-experimental/customers/{customerId}/unlocked-leads/{leadId}/reservation",
+    method: "DELETE",
+    operationId: "leadfyndr-remove-unlocked-lead-reservation-experimental",
+};
 /** List DeliveryBoxes belonging to a Project. */
 export const mailListDeliveryBoxes = {
     path: "/v2/projects/{projectId}/delivery-boxes",

package/dist/esm/version.js

@@ -1 +1 @@
-export const MittwaldAPIClientVersion = '4.147.0';
+export const MittwaldAPIClientVersion = '4.148.0';

package/dist/types/generated/v2/client-react.d.ts

@@ -1847,6 +1847,170 @@ declare const buildFileApi: (baseClient: MittwaldAPIV2Client) => {
         } | undefined;
     }) => import("@mittwald/react-use-promise").AsyncResource<string>;
 };
+declare const buildLeadFyndrApi: (baseClient: MittwaldAPIV2Client) => {
+    /** Get your LeadFyndr request. */
+    leadfyndrGetLeadFyndrProfileRequestExperimental: (conf: {
+        customerId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        createdOn: string;
+        customerId: string;
+        domain: string;
+        profileId: string;
+        requestedBy: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrUser;
+        resultOn?: string | undefined;
+        status: "AUTOTEST_INIT" | "MANUAL_VERIFICATION" | "REJECTED" | "APPROVED";
+    }>;
+    /** Get a simple lead. Use the unlocked route for more detail leads. */
+    leadfyndrGetLeadExperimental: (conf: {
+        leadId: string;
+        customerId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        businessFields: string[];
+        company: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrBasicCompany;
+        description: string;
+        globalUnlockedCount: number;
+        hoster: {
+            server: string[];
+        };
+        leadId: string;
+        mainTechnology?: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology | undefined;
+        metrics: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrBasicMetrics;
+        potential: number;
+        scannedAt?: string | undefined;
+        screenshot: string;
+        technologies: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology[];
+    }>;
+    /** Get your LeadFyndr profile. */
+    leadfyndrGetLeadFyndrProfileExperimental: (conf: {
+        customerId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        approvedOn: string;
+        customerId: string;
+        disabledOn?: string | undefined;
+        domain: string;
+        tariff: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTariffOptions;
+    }>;
+    /** Get lead tariff options. How many leads did you unlock this month? */
+    leadfyndrGetLeadFyndrProfileTariffOptionsExperimental: (conf: {
+        customerId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        reservation: {
+            available: number;
+            tariffLimit: number;
+            used: number;
+        };
+        unlocked: {
+            available: number;
+            tariffLimit: number;
+            used: number;
+        };
+    }>;
+    /** Get a detail of a unlocked lead. Organisation can unlock leads. */
+    leadfyndrGetUnlockedLeadExperimental: (conf: {
+        leadId: string;
+        customerId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        businessFields: string[];
+        company: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrDetailCompany;
+        contact: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrContact;
+        description: string;
+        domain: string;
+        globalUnlockedCount: number;
+        hoster: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrHoster;
+        leadId: string;
+        mainTechnology?: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology | undefined;
+        metrics: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrDetailMetrics;
+        potential: number;
+        reservedAt?: string | undefined;
+        scannedAt?: string | undefined;
+        screenshot: string;
+        socialMedia: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrSocialMedia[];
+        technologies: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology[];
+        unlockedAt: string;
+    }>;
+    /** Get all leads. Use the unlocked routes for more lead details. */
+    leadfyndrListLeadsExperimental: (conf: {
+        customerId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+        } | undefined;
+        queryParameters?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            potentialRangeMin?: number | undefined;
+            potentialRangeMax?: number | undefined;
+            employeeCountMin?: number | undefined;
+            employeeCountMax?: number | undefined;
+            salesVolumeMin?: number | undefined;
+            salesVolumeMax?: number | undefined;
+            technologies?: string[] | undefined;
+            "basic:timeToFirstByteMs:min"?: number | undefined;
+            "basic:timeToFirstByteMs:max"?: number | undefined;
+            "basic:desktop:performance:min"?: number | undefined;
+            "basic:desktop:performance:max"?: number | undefined;
+            "basic:mobile:performance:min"?: number | undefined;
+            "basic:mobile:performance:max"?: number | undefined;
+            limit?: number | undefined;
+            skip?: number | undefined;
+            page?: number | undefined;
+            sort?: ("potential" | "company.salesVolume" | "company.employeeCount" | "basic:desktop:performance" | "basic:mobile:performance" | "basic:desktop:seo" | "basic:mobile:seo")[] | undefined;
+            order?: ("asc" | "desc")[] | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        leads: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrLead[];
+        limit: number;
+        skip: number;
+        totalCount: number;
+    }>;
+    /** Get all unlocked leads. Organisation can unlock leads. */
+    leadfyndrListUnlockedLeadsExperimental: (conf: {
+        customerId: string;
+        headers?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+        } | undefined;
+        queryParameters?: {
+            [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
+            potentialRangeMin?: number | undefined;
+            potentialRangeMax?: number | undefined;
+            employeeCountMin?: number | undefined;
+            employeeCountMax?: number | undefined;
+            salesVolumeMin?: number | undefined;
+            salesVolumeMax?: number | undefined;
+            technologies?: string[] | undefined;
+            "basic:timeToFirstByteMs:min"?: number | undefined;
+            "basic:timeToFirstByteMs:max"?: number | undefined;
+            "basic:desktop:performance:min"?: number | undefined;
+            "basic:desktop:performance:max"?: number | undefined;
+            "basic:mobile:performance:min"?: number | undefined;
+            "basic:mobile:performance:max"?: number | undefined;
+            reserved?: boolean | undefined;
+            limit?: number | undefined;
+            skip?: number | undefined;
+            page?: number | undefined;
+            sort?: ("potential" | "company.salesVolume" | "company.employeeCount" | "basic:desktop:performance" | "basic:mobile:performance" | "basic:desktop:seo" | "basic:mobile:seo")[] | undefined;
+            order?: ("asc" | "desc")[] | undefined;
+        } | undefined;
+    }) => import("@mittwald/react-use-promise").AsyncResource<{
+        leads: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrUnlockedLead[];
+        limit: number;
+        skip: number;
+        totalCount: number;
+    }>;
+};
 declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
     /** List DeliveryBoxes belonging to a Project. */
     listDeliveryBoxes: (conf: {
@@ -2742,6 +2906,8 @@ export declare class MittwaldAPIV2ClientReact {
     readonly marketplace: ReturnType<typeof buildMarketplaceApi>;
     /** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
     readonly file: ReturnType<typeof buildFileApi>;
+    /** The lead fyndr api allow you to manage you leads and your fyndr profile. */
+    readonly leadFyndr: ReturnType<typeof buildLeadFyndrApi>;
     /** The mail API allows you to manage your mail accounts. */
     readonly mail: ReturnType<typeof buildMailApi>;
     /** The notification API allows you to manage your notifications. */