@mittwald/api-client 4.147.0 → 4.148.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -363,6 +363,22 @@ const buildSshsftpUserApi = (baseClient) => ({
363
363
  /** Get an SSHUser. */
364
364
  sshUserGetSshUser: new ApiCallAsyncResourceFactory(descriptors.sshUserGetSshUser, baseClient.sshsftpUser.sshUserGetSshUser).getApiResource,
365
365
  });
366
+ const buildLeadFyndrApi = (baseClient) => ({
367
+ /** Get a simple lead. Use the unlocked route for more detail leads. */
368
+ leadfyndrGetLeadExperimental: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetLeadExperimental, baseClient.leadFyndr.leadfyndrGetLeadExperimental).getApiResource,
369
+ /** Get all leads. Use the unlocked routes for more lead details. */
370
+ leadfyndrListLeadsExperimental: new ApiCallAsyncResourceFactory(descriptors.leadfyndrListLeadsExperimental, baseClient.leadFyndr.leadfyndrListLeadsExperimental).getApiResource,
371
+ /** Get a detail of a unlocked lead. Organisation can unlock leads. */
372
+ leadfyndrGetUnlockedLeadExperimental: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetUnlockedLeadExperimental, baseClient.leadFyndr.leadfyndrGetUnlockedLeadExperimental).getApiResource,
373
+ /** Get all unlocked leads. Organisation can unlock leads. */
374
+ leadfyndrListUnlockedLeadsExperimental: new ApiCallAsyncResourceFactory(descriptors.leadfyndrListUnlockedLeadsExperimental, baseClient.leadFyndr.leadfyndrListUnlockedLeadsExperimental).getApiResource,
375
+ /** Get lead tariff options. How many leads did you unlock this month? */
376
+ leadfyndrGetLeadFyndrProfileTariffOptionsExperimental: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetLeadFyndrProfileTariffOptionsExperimental, baseClient.leadFyndr.leadfyndrGetLeadFyndrProfileTariffOptionsExperimental).getApiResource,
377
+ /** Get your LeadFyndr profile. */
378
+ leadfyndrGetLeadFyndrProfileExperimental: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetLeadFyndrProfileExperimental, baseClient.leadFyndr.leadfyndrGetLeadFyndrProfileExperimental).getApiResource,
379
+ /** Get your LeadFyndr request. */
380
+ leadfyndrGetLeadFyndrProfileRequestExperimental: new ApiCallAsyncResourceFactory(descriptors.leadfyndrGetLeadFyndrProfileRequestExperimental, baseClient.leadFyndr.leadfyndrGetLeadFyndrProfileRequestExperimental).getApiResource,
381
+ });
366
382
  export class MittwaldAPIV2ClientReact {
367
383
  /** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
368
384
  app;
@@ -402,6 +418,8 @@ export class MittwaldAPIV2ClientReact {
402
418
  projectFileSystem;
403
419
  /** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
404
420
  sshsftpUser;
421
+ /** The lead fyndr api allow you to manage you leads and your fyndr profile. */
422
+ leadFyndr;
405
423
  constructor(baseClient) {
406
424
  this.app = buildAppApi(baseClient);
407
425
  this.article = buildArticleApi(baseClient);
@@ -422,6 +440,7 @@ export class MittwaldAPIV2ClientReact {
422
440
  this.project = buildProjectApi(baseClient);
423
441
  this.projectFileSystem = buildProjectFileSystemApi(baseClient);
424
442
  this.sshsftpUser = buildSshsftpUserApi(baseClient);
443
+ this.leadFyndr = buildLeadFyndrApi(baseClient);
425
444
  }
426
445
  static fromBaseClient(baseClient) {
427
446
  return new MittwaldAPIV2ClientReact(baseClient);
@@ -821,5 +821,30 @@ export class MittwaldAPIV2Client extends ApiClientBase {
821
821
  /** Update an SSHUser. */
822
822
  sshUserUpdateSshUser: this.requestFunctionFactory(descriptors.sshUserUpdateSshUser),
823
823
  };
824
+ /** The lead fyndr api allow you to manage you leads and your fyndr profile. */
825
+ leadFyndr = {
826
+ /** Reserve a unlocked lead for the given customerId. */
827
+ leadfyndrReserveUnlockedLeadExperimental: this.requestFunctionFactory(descriptors.leadfyndrReserveUnlockedLeadExperimental),
828
+ /** Removes a reservation on a unlocked lead for the given customerId. */
829
+ leadfyndrRemoveUnlockedLeadReservationExperimental: this.requestFunctionFactory(descriptors.leadfyndrRemoveUnlockedLeadReservationExperimental),
830
+ /** Get a simple lead. Use the unlocked route for more detail leads. */
831
+ leadfyndrGetLeadExperimental: this.requestFunctionFactory(descriptors.leadfyndrGetLeadExperimental),
832
+ /** Get all leads. Use the unlocked routes for more lead details. */
833
+ leadfyndrListLeadsExperimental: this.requestFunctionFactory(descriptors.leadfyndrListLeadsExperimental),
834
+ /** Get a detail of a unlocked lead. Organisation can unlock leads. */
835
+ leadfyndrGetUnlockedLeadExperimental: this.requestFunctionFactory(descriptors.leadfyndrGetUnlockedLeadExperimental),
836
+ /** Unlock a lead for the given customerId. */
837
+ leadfyndrUnlockLeadExperimental: this.requestFunctionFactory(descriptors.leadfyndrUnlockLeadExperimental),
838
+ /** Get all unlocked leads. Organisation can unlock leads. */
839
+ leadfyndrListUnlockedLeadsExperimental: this.requestFunctionFactory(descriptors.leadfyndrListUnlockedLeadsExperimental),
840
+ /** Get lead tariff options. How many leads did you unlock this month? */
841
+ leadfyndrGetLeadFyndrProfileTariffOptionsExperimental: this.requestFunctionFactory(descriptors.leadfyndrGetLeadFyndrProfileTariffOptionsExperimental),
842
+ /** Get your LeadFyndr profile. */
843
+ leadfyndrGetLeadFyndrProfileExperimental: this.requestFunctionFactory(descriptors.leadfyndrGetLeadFyndrProfileExperimental),
844
+ /** Get your LeadFyndr request. */
845
+ leadfyndrGetLeadFyndrProfileRequestExperimental: this.requestFunctionFactory(descriptors.leadfyndrGetLeadFyndrProfileRequestExperimental),
846
+ /** Create a new access request for LeadFyndr. */
847
+ leadfyndrCreateLeadFyndrAccessRequestExperimental: this.requestFunctionFactory(descriptors.leadfyndrCreateLeadFyndrAccessRequestExperimental),
848
+ };
824
849
  }
825
850
  export default MittwaldAPIV2Client;
@@ -2260,3 +2260,69 @@ export const verificationVerifyCompany = {
2260
2260
  method: "POST",
2261
2261
  operationId: "verification-verify-company",
2262
2262
  };
2263
+ /** Reserve a unlocked lead for the given customerId. */
2264
+ export const leadfyndrReserveUnlockedLeadExperimental = {
2265
+ path: "/v2-experimental/customers/{customerId}/unlocked-leads/{leadId}/reservation",
2266
+ method: "POST",
2267
+ operationId: "leadfyndr-reserve-unlocked-lead-experimental",
2268
+ };
2269
+ /** Removes a reservation on a unlocked lead for the given customerId. */
2270
+ export const leadfyndrRemoveUnlockedLeadReservationExperimental = {
2271
+ path: "/v2-experimental/customers/{customerId}/unlocked-leads/{leadId}/reservation",
2272
+ method: "DELETE",
2273
+ operationId: "leadfyndr-remove-unlocked-lead-reservation-experimental",
2274
+ };
2275
+ /** Get a simple lead. Use the unlocked route for more detail leads. */
2276
+ export const leadfyndrGetLeadExperimental = {
2277
+ path: "/v2-experimental/customers/{customerId}/leads/{leadId}",
2278
+ method: "GET",
2279
+ operationId: "leadfyndr-get-lead-experimental",
2280
+ };
2281
+ /** Get all leads. Use the unlocked routes for more lead details. */
2282
+ export const leadfyndrListLeadsExperimental = {
2283
+ path: "/v2-experimental/customers/{customerId}/leads",
2284
+ method: "GET",
2285
+ operationId: "leadfyndr-list-leads-experimental",
2286
+ };
2287
+ /** Get a detail of a unlocked lead. Organisation can unlock leads. */
2288
+ export const leadfyndrGetUnlockedLeadExperimental = {
2289
+ path: "/v2-experimental/customers/{customerId}/unlocked-leads/{leadId}",
2290
+ method: "GET",
2291
+ operationId: "leadfyndr-get-unlocked-lead-experimental",
2292
+ };
2293
+ /** Unlock a lead for the given customerId. */
2294
+ export const leadfyndrUnlockLeadExperimental = {
2295
+ path: "/v2-experimental/customers/{customerId}/unlocked-leads/{leadId}",
2296
+ method: "POST",
2297
+ operationId: "leadfyndr-unlock-lead-experimental",
2298
+ };
2299
+ /** Get all unlocked leads. Organisation can unlock leads. */
2300
+ export const leadfyndrListUnlockedLeadsExperimental = {
2301
+ path: "/v2-experimental/customers/{customerId}/unlocked-leads",
2302
+ method: "GET",
2303
+ operationId: "leadfyndr-list-unlocked-leads-experimental",
2304
+ };
2305
+ /** Get lead tariff options. How many leads did you unlock this month? */
2306
+ export const leadfyndrGetLeadFyndrProfileTariffOptionsExperimental = {
2307
+ path: "/v2-experimental/customers/{customerId}/lead-fyndr-profile/tariff",
2308
+ method: "GET",
2309
+ operationId: "leadfyndr-get-lead-fyndr-profile-tariff-options-experimental",
2310
+ };
2311
+ /** Get your LeadFyndr profile. */
2312
+ export const leadfyndrGetLeadFyndrProfileExperimental = {
2313
+ path: "/v2-experimental/customers/{customerId}/lead-fyndr-profile",
2314
+ method: "GET",
2315
+ operationId: "leadfyndr-get-lead-fyndr-profile-experimental",
2316
+ };
2317
+ /** Get your LeadFyndr request. */
2318
+ export const leadfyndrGetLeadFyndrProfileRequestExperimental = {
2319
+ path: "/v2-experimental/customers/{customerId}/lead-fyndr-profile-request",
2320
+ method: "GET",
2321
+ operationId: "leadfyndr-get-lead-fyndr-profile-request-experimental",
2322
+ };
2323
+ /** Create a new access request for LeadFyndr. */
2324
+ export const leadfyndrCreateLeadFyndrAccessRequestExperimental = {
2325
+ path: "/v2-experimental/customers/{customerId}/lead-fyndr-profile-request",
2326
+ method: "POST",
2327
+ operationId: "leadfyndr-create-lead-fyndr-access-request-experimental",
2328
+ };
@@ -1 +1 @@
1
- export const MittwaldAPIClientVersion = '4.146.0';
1
+ export const MittwaldAPIClientVersion = '4.147.1';
@@ -2717,6 +2717,170 @@ declare const buildSshsftpUserApi: (baseClient: MittwaldAPIV2Client) => {
2717
2717
  userName: string;
2718
2718
  }>;
2719
2719
  };
2720
+ declare const buildLeadFyndrApi: (baseClient: MittwaldAPIV2Client) => {
2721
+ /** Get a simple lead. Use the unlocked route for more detail leads. */
2722
+ leadfyndrGetLeadExperimental: (conf: {
2723
+ leadId: string;
2724
+ customerId: string;
2725
+ headers?: {
2726
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2727
+ } | undefined;
2728
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2729
+ businessFields: string[];
2730
+ company: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrBasicCompany;
2731
+ description: string;
2732
+ globalUnlockedCount: number;
2733
+ hoster: {
2734
+ server: string[];
2735
+ };
2736
+ leadId: string;
2737
+ mainTechnology?: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology | undefined;
2738
+ metrics: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrBasicMetrics;
2739
+ potential: number;
2740
+ scannedAt?: string | undefined;
2741
+ screenshot: string;
2742
+ technologies: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology[];
2743
+ }>;
2744
+ /** Get all leads. Use the unlocked routes for more lead details. */
2745
+ leadfyndrListLeadsExperimental: (conf: {
2746
+ customerId: string;
2747
+ headers?: {
2748
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2749
+ } | undefined;
2750
+ queryParameters?: {
2751
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2752
+ potentialRangeMin?: number | undefined;
2753
+ potentialRangeMax?: number | undefined;
2754
+ employeeCountMin?: number | undefined;
2755
+ employeeCountMax?: number | undefined;
2756
+ salesVolumeMin?: number | undefined;
2757
+ salesVolumeMax?: number | undefined;
2758
+ technologies?: string[] | undefined;
2759
+ "basic:timeToFirstByteMs:min"?: number | undefined;
2760
+ "basic:timeToFirstByteMs:max"?: number | undefined;
2761
+ "basic:desktop:performance:min"?: number | undefined;
2762
+ "basic:desktop:performance:max"?: number | undefined;
2763
+ "basic:mobile:performance:min"?: number | undefined;
2764
+ "basic:mobile:performance:max"?: number | undefined;
2765
+ limit?: number | undefined;
2766
+ skip?: number | undefined;
2767
+ page?: number | undefined;
2768
+ sort?: ("potential" | "company.salesVolume" | "company.employeeCount" | "basic:desktop:performance" | "basic:mobile:performance" | "basic:desktop:seo" | "basic:mobile:seo")[] | undefined;
2769
+ order?: ("asc" | "desc")[] | undefined;
2770
+ } | undefined;
2771
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2772
+ leads: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrLead[];
2773
+ limit: number;
2774
+ skip: number;
2775
+ totalCount: number;
2776
+ }>;
2777
+ /** Get a detail of a unlocked lead. Organisation can unlock leads. */
2778
+ leadfyndrGetUnlockedLeadExperimental: (conf: {
2779
+ leadId: string;
2780
+ customerId: string;
2781
+ headers?: {
2782
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2783
+ } | undefined;
2784
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2785
+ businessFields: string[];
2786
+ company: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrDetailCompany;
2787
+ contact: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrContact;
2788
+ description: string;
2789
+ domain: string;
2790
+ globalUnlockedCount: number;
2791
+ hoster: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrHoster;
2792
+ leadId: string;
2793
+ mainTechnology?: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology | undefined;
2794
+ metrics: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrDetailMetrics;
2795
+ potential: number;
2796
+ reservedAt?: string | undefined;
2797
+ scannedAt?: string | undefined;
2798
+ screenshot: string;
2799
+ socialMedia: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrSocialMedia[];
2800
+ technologies: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology[];
2801
+ unlockedAt: string;
2802
+ }>;
2803
+ /** Get all unlocked leads. Organisation can unlock leads. */
2804
+ leadfyndrListUnlockedLeadsExperimental: (conf: {
2805
+ customerId: string;
2806
+ headers?: {
2807
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2808
+ } | undefined;
2809
+ queryParameters?: {
2810
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2811
+ potentialRangeMin?: number | undefined;
2812
+ potentialRangeMax?: number | undefined;
2813
+ employeeCountMin?: number | undefined;
2814
+ employeeCountMax?: number | undefined;
2815
+ salesVolumeMin?: number | undefined;
2816
+ salesVolumeMax?: number | undefined;
2817
+ technologies?: string[] | undefined;
2818
+ "basic:timeToFirstByteMs:min"?: number | undefined;
2819
+ "basic:timeToFirstByteMs:max"?: number | undefined;
2820
+ "basic:desktop:performance:min"?: number | undefined;
2821
+ "basic:desktop:performance:max"?: number | undefined;
2822
+ "basic:mobile:performance:min"?: number | undefined;
2823
+ "basic:mobile:performance:max"?: number | undefined;
2824
+ reserved?: boolean | undefined;
2825
+ limit?: number | undefined;
2826
+ skip?: number | undefined;
2827
+ page?: number | undefined;
2828
+ sort?: ("potential" | "company.salesVolume" | "company.employeeCount" | "basic:desktop:performance" | "basic:mobile:performance" | "basic:desktop:seo" | "basic:mobile:seo")[] | undefined;
2829
+ order?: ("asc" | "desc")[] | undefined;
2830
+ } | undefined;
2831
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2832
+ leads: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrUnlockedLead[];
2833
+ limit: number;
2834
+ skip: number;
2835
+ totalCount: number;
2836
+ }>;
2837
+ /** Get lead tariff options. How many leads did you unlock this month? */
2838
+ leadfyndrGetLeadFyndrProfileTariffOptionsExperimental: (conf: {
2839
+ customerId: string;
2840
+ headers?: {
2841
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2842
+ } | undefined;
2843
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2844
+ reservation: {
2845
+ available: number;
2846
+ tariffLimit: number;
2847
+ used: number;
2848
+ };
2849
+ unlocked: {
2850
+ available: number;
2851
+ tariffLimit: number;
2852
+ used: number;
2853
+ };
2854
+ }>;
2855
+ /** Get your LeadFyndr profile. */
2856
+ leadfyndrGetLeadFyndrProfileExperimental: (conf: {
2857
+ customerId: string;
2858
+ headers?: {
2859
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2860
+ } | undefined;
2861
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2862
+ approvedOn: string;
2863
+ customerId: string;
2864
+ disabledOn?: string | undefined;
2865
+ domain: string;
2866
+ tariff: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTariffOptions;
2867
+ }>;
2868
+ /** Get your LeadFyndr request. */
2869
+ leadfyndrGetLeadFyndrProfileRequestExperimental: (conf: {
2870
+ customerId: string;
2871
+ headers?: {
2872
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2873
+ } | undefined;
2874
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2875
+ createdOn: string;
2876
+ customerId: string;
2877
+ domain: string;
2878
+ profileId: string;
2879
+ requestedBy: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrUser;
2880
+ resultOn?: string | undefined;
2881
+ status: "AUTOTEST_INIT" | "MANUAL_VERIFICATION" | "REJECTED" | "APPROVED";
2882
+ }>;
2883
+ };
2720
2884
  export declare class MittwaldAPIV2ClientReact {
2721
2885
  /** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
2722
2886
  readonly app: ReturnType<typeof buildAppApi>;
@@ -2756,6 +2920,8 @@ export declare class MittwaldAPIV2ClientReact {
2756
2920
  readonly projectFileSystem: ReturnType<typeof buildProjectFileSystemApi>;
2757
2921
  /** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
2758
2922
  readonly sshsftpUser: ReturnType<typeof buildSshsftpUserApi>;
2923
+ /** The lead fyndr api allow you to manage you leads and your fyndr profile. */
2924
+ readonly leadFyndr: ReturnType<typeof buildLeadFyndrApi>;
2759
2925
  private constructor();
2760
2926
  static fromBaseClient(baseClient: MittwaldAPIV2Client): MittwaldAPIV2ClientReact;
2761
2927
  }