@mittwald/api-client 4.523.0 → 4.525.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.
- package/dist/esm/generated/v2/client-react.js +2 -25
- package/dist/esm/generated/v2/client.js +6 -35
- package/dist/esm/generated/v2/descriptors.js +16 -94
- package/dist/esm/generated/v3-next/client-react.js +2 -25
- package/dist/esm/generated/v3-next/client.js +6 -35
- package/dist/esm/generated/v3-next/descriptors.js +16 -94
- package/dist/esm/version.js +1 -1
- package/dist/types/generated/v2/client-react.d.ts +14 -216
- package/dist/types/generated/v2/client.d.ts +413 -1290
- package/dist/types/generated/v2/descriptors.d.ts +10 -36
- package/dist/types/generated/v2/types.d.ts +620 -1626
- package/dist/types/generated/v3-next/client-react.d.ts +14 -216
- package/dist/types/generated/v3-next/client.d.ts +413 -1290
- package/dist/types/generated/v3-next/descriptors.d.ts +10 -36
- package/dist/types/generated/v3-next/types.d.ts +622 -1606
- package/dist/types/version.d.ts +1 -1
- package/package.json +4 -4
|
@@ -2842,206 +2842,6 @@ declare const buildFileApi: (baseClient: MittwaldAPIV3NextClient) => {
|
|
|
2842
2842
|
} | undefined;
|
|
2843
2843
|
}) => import("@mittwald/react-use-promise").AsyncResource<string>;
|
|
2844
2844
|
};
|
|
2845
|
-
declare const buildLeadFyndrApi: (baseClient: MittwaldAPIV3NextClient) => {
|
|
2846
|
-
/** Get your LeadFyndr request. */
|
|
2847
|
-
leadfyndrGetLeadFyndrProfileRequest: (conf: {
|
|
2848
|
-
customerId: string;
|
|
2849
|
-
headers?: {
|
|
2850
|
-
[x: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[] | undefined;
|
|
2851
|
-
} | undefined;
|
|
2852
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2853
|
-
createdOn: string;
|
|
2854
|
-
customerId: string;
|
|
2855
|
-
domain: string;
|
|
2856
|
-
profileId: string;
|
|
2857
|
-
requestedBy: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrUser;
|
|
2858
|
-
resultOn?: string | undefined;
|
|
2859
|
-
status: "AUTOTEST_INIT" | "MANUAL_VERIFICATION" | "REJECTED" | "APPROVED";
|
|
2860
|
-
}>;
|
|
2861
|
-
/** Get cities in DACH. */
|
|
2862
|
-
leadfyndrGetCities: (conf: {
|
|
2863
|
-
queryParameters: {
|
|
2864
|
-
[x: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[] | undefined;
|
|
2865
|
-
input: string;
|
|
2866
|
-
};
|
|
2867
|
-
headers?: {
|
|
2868
|
-
[x: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[] | undefined;
|
|
2869
|
-
} | undefined;
|
|
2870
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrCity[]>;
|
|
2871
|
-
/** Get lead tariff options. How many leads did you unlock this month? */
|
|
2872
|
-
leadfyndrGetLeadFyndrProfileTariffOptions: (conf: {
|
|
2873
|
-
customerId: string;
|
|
2874
|
-
headers?: {
|
|
2875
|
-
[x: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[] | undefined;
|
|
2876
|
-
} | undefined;
|
|
2877
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2878
|
-
nextUnlockRenewalDate?: string | undefined;
|
|
2879
|
-
reservation: {
|
|
2880
|
-
available: number;
|
|
2881
|
-
tariffLimit: number;
|
|
2882
|
-
used: number;
|
|
2883
|
-
};
|
|
2884
|
-
unlocked: {
|
|
2885
|
-
available: number;
|
|
2886
|
-
tariffLimit: number;
|
|
2887
|
-
used: number;
|
|
2888
|
-
};
|
|
2889
|
-
}>;
|
|
2890
|
-
/** Get your LeadFyndr profile. */
|
|
2891
|
-
leadfyndrGetLeadFyndrProfile: (conf: {
|
|
2892
|
-
customerId: string;
|
|
2893
|
-
headers?: {
|
|
2894
|
-
[x: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[] | undefined;
|
|
2895
|
-
} | undefined;
|
|
2896
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2897
|
-
approvedOn: string;
|
|
2898
|
-
customerId: string;
|
|
2899
|
-
disabledOn?: string | undefined;
|
|
2900
|
-
domain: string;
|
|
2901
|
-
tariff: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrTariffOptions;
|
|
2902
|
-
}>;
|
|
2903
|
-
/** Get a simple lead. Use the unlocked route for more detail leads. */
|
|
2904
|
-
leadfyndrGetLead: (conf: {
|
|
2905
|
-
leadId: string;
|
|
2906
|
-
customerId: string;
|
|
2907
|
-
headers?: {
|
|
2908
|
-
[x: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[] | undefined;
|
|
2909
|
-
} | undefined;
|
|
2910
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2911
|
-
businessFields: string[];
|
|
2912
|
-
company: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrBasicCompany;
|
|
2913
|
-
description: string;
|
|
2914
|
-
hoster: {
|
|
2915
|
-
server: string[];
|
|
2916
|
-
};
|
|
2917
|
-
languages: string[];
|
|
2918
|
-
leadId: string;
|
|
2919
|
-
mainTechnology?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrTechnology | undefined;
|
|
2920
|
-
metrics: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrBasicMetrics;
|
|
2921
|
-
potential: number;
|
|
2922
|
-
scannedAt?: string | undefined;
|
|
2923
|
-
screenshot: string;
|
|
2924
|
-
technologies: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrTechnology[];
|
|
2925
|
-
}>;
|
|
2926
|
-
/** Get unlocked leads export history for the given customerId. */
|
|
2927
|
-
leadfyndrGetLeadsExportHistory: (conf: {
|
|
2928
|
-
customerId: string;
|
|
2929
|
-
queryParameters?: {
|
|
2930
|
-
[x: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[] | undefined;
|
|
2931
|
-
limit?: number | undefined;
|
|
2932
|
-
skip?: number | undefined;
|
|
2933
|
-
page?: number | undefined;
|
|
2934
|
-
sort?: "exportedAt" | undefined;
|
|
2935
|
-
order?: "asc" | "desc" | undefined;
|
|
2936
|
-
} | undefined;
|
|
2937
|
-
headers?: {
|
|
2938
|
-
[x: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[] | undefined;
|
|
2939
|
-
} | undefined;
|
|
2940
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrLeadsExport[]>;
|
|
2941
|
-
/** Get a detail of a unlocked lead. Organisation can unlock leads. */
|
|
2942
|
-
leadfyndrGetUnlockedLead: (conf: {
|
|
2943
|
-
leadId: string;
|
|
2944
|
-
customerId: string;
|
|
2945
|
-
headers?: {
|
|
2946
|
-
[x: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[] | undefined;
|
|
2947
|
-
} | undefined;
|
|
2948
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
2949
|
-
actualUrl: string;
|
|
2950
|
-
businessFields: string[];
|
|
2951
|
-
company: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrDetailCompany;
|
|
2952
|
-
contact: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrContact;
|
|
2953
|
-
description: string;
|
|
2954
|
-
domain: string;
|
|
2955
|
-
hoster: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrHoster;
|
|
2956
|
-
languages: string[];
|
|
2957
|
-
leadId: string;
|
|
2958
|
-
mainTechnology?: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrTechnology | undefined;
|
|
2959
|
-
metrics: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrDetailMetrics;
|
|
2960
|
-
potential: number;
|
|
2961
|
-
reservationAllowed?: boolean | undefined;
|
|
2962
|
-
reservedAt?: string | undefined;
|
|
2963
|
-
scannedAt?: string | undefined;
|
|
2964
|
-
screenshot: string;
|
|
2965
|
-
socialMedia: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrSocialMedia[];
|
|
2966
|
-
technologies: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrTechnology[];
|
|
2967
|
-
unlockedAt: string;
|
|
2968
|
-
}>;
|
|
2969
|
-
/** Get all leads. Use the unlocked routes for more lead details. */
|
|
2970
|
-
leadfyndrListLeads: (conf: {
|
|
2971
|
-
customerId: string;
|
|
2972
|
-
queryParameters?: {
|
|
2973
|
-
[x: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[] | undefined;
|
|
2974
|
-
potentialRangeMin?: number | undefined;
|
|
2975
|
-
potentialRangeMax?: number | undefined;
|
|
2976
|
-
employeeCountMin?: number | undefined;
|
|
2977
|
-
employeeCountMax?: number | undefined;
|
|
2978
|
-
salesVolumeMin?: number | undefined;
|
|
2979
|
-
salesVolumeMax?: number | undefined;
|
|
2980
|
-
technologies?: (string | "none")[] | undefined;
|
|
2981
|
-
businessFields?: string[] | undefined;
|
|
2982
|
-
locationCity?: string | undefined;
|
|
2983
|
-
locationPostCode?: string | undefined;
|
|
2984
|
-
locationRadiusInKm?: number | undefined;
|
|
2985
|
-
"basic:timeToFirstByteMs:min"?: number | undefined;
|
|
2986
|
-
"basic:timeToFirstByteMs:max"?: number | undefined;
|
|
2987
|
-
"basic:desktop:performance:min"?: number | undefined;
|
|
2988
|
-
"basic:desktop:performance:max"?: number | undefined;
|
|
2989
|
-
"basic:mobile:performance:min"?: number | undefined;
|
|
2990
|
-
"basic:mobile:performance:max"?: number | undefined;
|
|
2991
|
-
limit?: number | undefined;
|
|
2992
|
-
skip?: number | undefined;
|
|
2993
|
-
page?: number | undefined;
|
|
2994
|
-
sort?: "potential" | "relevance" | undefined;
|
|
2995
|
-
order?: "asc" | "desc" | undefined;
|
|
2996
|
-
} | undefined;
|
|
2997
|
-
headers?: {
|
|
2998
|
-
[x: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[] | undefined;
|
|
2999
|
-
} | undefined;
|
|
3000
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
3001
|
-
leads: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrLead[];
|
|
3002
|
-
limit: number;
|
|
3003
|
-
skip: number;
|
|
3004
|
-
totalCount: number;
|
|
3005
|
-
}>;
|
|
3006
|
-
/** Get all unlocked leads. Organisation can unlock leads. */
|
|
3007
|
-
leadfyndrListUnlockedLeads: (conf: {
|
|
3008
|
-
customerId: string;
|
|
3009
|
-
queryParameters?: {
|
|
3010
|
-
[x: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[] | undefined;
|
|
3011
|
-
potentialRangeMin?: number | undefined;
|
|
3012
|
-
potentialRangeMax?: number | undefined;
|
|
3013
|
-
employeeCountMin?: number | undefined;
|
|
3014
|
-
employeeCountMax?: number | undefined;
|
|
3015
|
-
salesVolumeMin?: number | undefined;
|
|
3016
|
-
salesVolumeMax?: number | undefined;
|
|
3017
|
-
technologies?: (string | "none")[] | undefined;
|
|
3018
|
-
businessFields?: string[] | undefined;
|
|
3019
|
-
locationCity?: string | undefined;
|
|
3020
|
-
locationPostCode?: string | undefined;
|
|
3021
|
-
locationRadiusInKm?: number | undefined;
|
|
3022
|
-
"basic:timeToFirstByteMs:min"?: number | undefined;
|
|
3023
|
-
"basic:timeToFirstByteMs:max"?: number | undefined;
|
|
3024
|
-
"basic:desktop:performance:min"?: number | undefined;
|
|
3025
|
-
"basic:desktop:performance:max"?: number | undefined;
|
|
3026
|
-
"basic:mobile:performance:min"?: number | undefined;
|
|
3027
|
-
"basic:mobile:performance:max"?: number | undefined;
|
|
3028
|
-
reserved?: boolean | undefined;
|
|
3029
|
-
limit?: number | undefined;
|
|
3030
|
-
skip?: number | undefined;
|
|
3031
|
-
page?: number | undefined;
|
|
3032
|
-
sort?: "potential" | "relevance" | "company" | undefined;
|
|
3033
|
-
order?: "asc" | "desc" | undefined;
|
|
3034
|
-
} | undefined;
|
|
3035
|
-
headers?: {
|
|
3036
|
-
[x: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[] | undefined;
|
|
3037
|
-
} | undefined;
|
|
3038
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
3039
|
-
leads: import("./types.js").MittwaldAPIV3Next.Components.Schemas.DeMittwaldLeadfyndrUnlockedLead[];
|
|
3040
|
-
limit: number;
|
|
3041
|
-
skip: number;
|
|
3042
|
-
totalCount: number;
|
|
3043
|
-
}>;
|
|
3044
|
-
};
|
|
3045
2845
|
declare const buildLicenseApi: (baseClient: MittwaldAPIV3NextClient) => {
|
|
3046
2846
|
/** Get a license. */
|
|
3047
2847
|
getLicense: (conf: {
|
|
@@ -3516,6 +3316,20 @@ declare const buildUserApi: (baseClient: MittwaldAPIV3NextClient) => {
|
|
|
3516
3316
|
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
3517
3317
|
settingsString?: string | undefined;
|
|
3518
3318
|
}>;
|
|
3319
|
+
/** Get poll settings for the specified user. */
|
|
3320
|
+
getPollStatus: (conf: {
|
|
3321
|
+
userId: string;
|
|
3322
|
+
headers?: {
|
|
3323
|
+
[x: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[] | undefined;
|
|
3324
|
+
} | undefined;
|
|
3325
|
+
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
3326
|
+
completedAt?: string | undefined;
|
|
3327
|
+
dontShowUntil?: string | undefined;
|
|
3328
|
+
ignoredAt?: string | undefined;
|
|
3329
|
+
shouldShow: boolean;
|
|
3330
|
+
status: "completed" | "muted" | "ignored" | "new";
|
|
3331
|
+
userId: string;
|
|
3332
|
+
}>;
|
|
3519
3333
|
/** Get a specific session. */
|
|
3520
3334
|
getSession: (conf: {
|
|
3521
3335
|
tokenId: string;
|
|
@@ -3637,20 +3451,6 @@ declare const buildUserApi: (baseClient: MittwaldAPIV3NextClient) => {
|
|
|
3637
3451
|
expiresAt: string;
|
|
3638
3452
|
supportCode: string;
|
|
3639
3453
|
}>;
|
|
3640
|
-
/** Get poll settings for the specified user. */
|
|
3641
|
-
getPollStatus: (conf: {
|
|
3642
|
-
userId: string;
|
|
3643
|
-
headers?: {
|
|
3644
|
-
[x: string]: (string | number | boolean | Date) | (string | number | boolean | Date)[] | undefined;
|
|
3645
|
-
} | undefined;
|
|
3646
|
-
}) => import("@mittwald/react-use-promise").AsyncResource<{
|
|
3647
|
-
completedAt?: string | undefined;
|
|
3648
|
-
dontShowUntil?: string | undefined;
|
|
3649
|
-
ignoredAt?: string | undefined;
|
|
3650
|
-
shouldShow: boolean;
|
|
3651
|
-
status: "completed" | "muted" | "ignored" | "new";
|
|
3652
|
-
userId: string;
|
|
3653
|
-
}>;
|
|
3654
3454
|
};
|
|
3655
3455
|
declare const buildProjectApi: (baseClient: MittwaldAPIV3NextClient) => {
|
|
3656
3456
|
/** List Invites belonging to a Project. */
|
|
@@ -4232,8 +4032,6 @@ export declare class MittwaldAPIV3NextClientReact {
|
|
|
4232
4032
|
readonly domain: ReturnType<typeof buildDomainApi>;
|
|
4233
4033
|
/** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
|
|
4234
4034
|
readonly file: ReturnType<typeof buildFileApi>;
|
|
4235
|
-
/** The lead fyndr api allow you to manage you leads and your fyndr profile. */
|
|
4236
|
-
readonly leadFyndr: ReturnType<typeof buildLeadFyndrApi>;
|
|
4237
4035
|
/** The license API allows you to manage your paid licenses. */
|
|
4238
4036
|
readonly license: ReturnType<typeof buildLicenseApi>;
|
|
4239
4037
|
/** The mail API allows you to manage your mail accounts. */
|