@mittwald/api-client 4.169.0 → 4.171.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.
@@ -1407,11 +1407,14 @@ declare const buildCustomerApi: (baseClient: MittwaldAPIV2Client) => {
1407
1407
  "x-access-token"?: string | undefined;
1408
1408
  } | undefined;
1409
1409
  }) => import("@mittwald/react-use-promise").AsyncResource<{
1410
+ avatarRef?: string | undefined;
1410
1411
  customerId: string;
1411
1412
  email: string;
1412
1413
  expiresAt?: string | undefined;
1414
+ firstName: string;
1413
1415
  id: string;
1414
1416
  inviteId?: string | undefined;
1417
+ lastName: string;
1415
1418
  memberSince?: string | undefined;
1416
1419
  mfa: boolean;
1417
1420
  role: import("./types.js").MittwaldAPIV2.Components.Schemas.MembershipCustomerRoles;
@@ -1986,191 +1989,6 @@ declare const buildFileApi: (baseClient: MittwaldAPIV2Client) => {
1986
1989
  } | undefined;
1987
1990
  }) => import("@mittwald/react-use-promise").AsyncResource<string>;
1988
1991
  };
1989
- declare const buildLeadFyndrApi: (baseClient: MittwaldAPIV2Client) => {
1990
- /** Get your LeadFyndr request. */
1991
- leadfyndrGetLeadFyndrProfileRequestExperimental: (conf: {
1992
- customerId: string;
1993
- headers?: {
1994
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1995
- } | undefined;
1996
- }) => import("@mittwald/react-use-promise").AsyncResource<{
1997
- createdOn: string;
1998
- customerId: string;
1999
- domain: string;
2000
- profileId: string;
2001
- requestedBy: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrUser;
2002
- resultOn?: string | undefined;
2003
- status: "AUTOTEST_INIT" | "MANUAL_VERIFICATION" | "REJECTED" | "APPROVED";
2004
- }>;
2005
- /** Get cities in DACH. */
2006
- leadfyndrGetCitiesExperimental: (conf: {
2007
- queryParameters: {
2008
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2009
- input: string;
2010
- };
2011
- headers?: {
2012
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2013
- } | undefined;
2014
- }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrCity[]>;
2015
- /** Get a simple lead. Use the unlocked route for more detail leads. */
2016
- leadfyndrGetLeadExperimental: (conf: {
2017
- leadId: string;
2018
- customerId: string;
2019
- headers?: {
2020
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2021
- } | undefined;
2022
- }) => import("@mittwald/react-use-promise").AsyncResource<{
2023
- businessFields: string[];
2024
- company: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrBasicCompany;
2025
- description: string;
2026
- hoster: {
2027
- server: string[];
2028
- };
2029
- languages: string[];
2030
- leadId: string;
2031
- mainTechnology?: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology | undefined;
2032
- metrics: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrBasicMetrics;
2033
- potential: number;
2034
- scannedAt?: string | undefined;
2035
- screenshot: string;
2036
- technologies: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology[];
2037
- }>;
2038
- /** Get your LeadFyndr profile. */
2039
- leadfyndrGetLeadFyndrProfileExperimental: (conf: {
2040
- customerId: string;
2041
- headers?: {
2042
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2043
- } | undefined;
2044
- }) => import("@mittwald/react-use-promise").AsyncResource<{
2045
- approvedOn: string;
2046
- customerId: string;
2047
- disabledOn?: string | undefined;
2048
- domain: string;
2049
- tariff: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTariffOptions;
2050
- }>;
2051
- /** Get lead tariff options. How many leads did you unlock this month? */
2052
- leadfyndrGetLeadFyndrProfileTariffOptionsExperimental: (conf: {
2053
- customerId: string;
2054
- headers?: {
2055
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2056
- } | undefined;
2057
- }) => import("@mittwald/react-use-promise").AsyncResource<{
2058
- nextUnlockRenewalDate?: string | undefined;
2059
- reservation: {
2060
- available: number;
2061
- tariffLimit: number;
2062
- used: number;
2063
- };
2064
- unlocked: {
2065
- available: number;
2066
- tariffLimit: number;
2067
- used: number;
2068
- };
2069
- }>;
2070
- /** Get a detail of a unlocked lead. Organisation can unlock leads. */
2071
- leadfyndrGetUnlockedLeadExperimental: (conf: {
2072
- leadId: string;
2073
- customerId: string;
2074
- headers?: {
2075
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2076
- } | undefined;
2077
- }) => import("@mittwald/react-use-promise").AsyncResource<{
2078
- actualUrl: string;
2079
- businessFields: string[];
2080
- company: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrDetailCompany;
2081
- contact: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrContact;
2082
- description: string;
2083
- domain: string;
2084
- hoster: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrHoster;
2085
- languages: string[];
2086
- leadId: string;
2087
- mainTechnology?: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology | undefined;
2088
- metrics: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrDetailMetrics;
2089
- potential: number;
2090
- reservationAllowed?: boolean | undefined;
2091
- reservedAt?: string | undefined;
2092
- scannedAt?: string | undefined;
2093
- screenshot: string;
2094
- socialMedia: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrSocialMedia[];
2095
- technologies: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology[];
2096
- unlockedAt: string;
2097
- }>;
2098
- /** Get all leads. Use the unlocked routes for more lead details. */
2099
- leadfyndrListLeadsExperimental: (conf: {
2100
- customerId: string;
2101
- headers?: {
2102
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2103
- } | undefined;
2104
- queryParameters?: {
2105
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2106
- potentialRangeMin?: number | undefined;
2107
- potentialRangeMax?: number | undefined;
2108
- employeeCountMin?: number | undefined;
2109
- employeeCountMax?: number | undefined;
2110
- salesVolumeMin?: number | undefined;
2111
- salesVolumeMax?: number | undefined;
2112
- technologies?: string[] | undefined;
2113
- businessFields?: string[] | undefined;
2114
- locationCity?: string | undefined;
2115
- locationPostCode?: string | undefined;
2116
- locationRadiusInKm?: number | undefined;
2117
- "basic:timeToFirstByteMs:min"?: number | undefined;
2118
- "basic:timeToFirstByteMs:max"?: number | undefined;
2119
- "basic:desktop:performance:min"?: number | undefined;
2120
- "basic:desktop:performance:max"?: number | undefined;
2121
- "basic:mobile:performance:min"?: number | undefined;
2122
- "basic:mobile:performance:max"?: number | undefined;
2123
- limit?: number | undefined;
2124
- skip?: number | undefined;
2125
- page?: number | undefined;
2126
- sort?: "potential" | "relevance" | undefined;
2127
- order?: "asc" | "desc" | undefined;
2128
- } | undefined;
2129
- }) => import("@mittwald/react-use-promise").AsyncResource<{
2130
- leads: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrLead[];
2131
- limit: number;
2132
- skip: number;
2133
- totalCount: number;
2134
- }>;
2135
- /** Get all unlocked leads. Organisation can unlock leads. */
2136
- leadfyndrListUnlockedLeadsExperimental: (conf: {
2137
- customerId: string;
2138
- headers?: {
2139
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2140
- } | undefined;
2141
- queryParameters?: {
2142
- [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2143
- potentialRangeMin?: number | undefined;
2144
- potentialRangeMax?: number | undefined;
2145
- employeeCountMin?: number | undefined;
2146
- employeeCountMax?: number | undefined;
2147
- salesVolumeMin?: number | undefined;
2148
- salesVolumeMax?: number | undefined;
2149
- technologies?: string[] | undefined;
2150
- businessFields?: string[] | undefined;
2151
- locationCity?: string | undefined;
2152
- locationPostCode?: string | undefined;
2153
- locationRadiusInKm?: number | undefined;
2154
- "basic:timeToFirstByteMs:min"?: number | undefined;
2155
- "basic:timeToFirstByteMs:max"?: number | undefined;
2156
- "basic:desktop:performance:min"?: number | undefined;
2157
- "basic:desktop:performance:max"?: number | undefined;
2158
- "basic:mobile:performance:min"?: number | undefined;
2159
- "basic:mobile:performance:max"?: number | undefined;
2160
- reserved?: boolean | undefined;
2161
- limit?: number | undefined;
2162
- skip?: number | undefined;
2163
- page?: number | undefined;
2164
- sort?: "potential" | "relevance" | undefined;
2165
- order?: "asc" | "desc" | undefined;
2166
- } | undefined;
2167
- }) => import("@mittwald/react-use-promise").AsyncResource<{
2168
- leads: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrUnlockedLead[];
2169
- limit: number;
2170
- skip: number;
2171
- totalCount: number;
2172
- }>;
2173
- };
2174
1992
  declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
2175
1993
  /** List DeliveryBoxes belonging to a Project. */
2176
1994
  listDeliveryBoxes: (conf: {
@@ -3043,6 +2861,191 @@ declare const buildSshsftpUserApi: (baseClient: MittwaldAPIV2Client) => {
3043
2861
  userName: string;
3044
2862
  }>;
3045
2863
  };
2864
+ declare const buildLeadFyndrApi: (baseClient: MittwaldAPIV2Client) => {
2865
+ /** Get cities in DACH. */
2866
+ leadfyndrGetCities: (conf: {
2867
+ queryParameters: {
2868
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2869
+ input: string;
2870
+ };
2871
+ headers?: {
2872
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2873
+ } | undefined;
2874
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrCity[]>;
2875
+ /** Get a simple lead. Use the unlocked route for more detail leads. */
2876
+ leadfyndrGetLead: (conf: {
2877
+ leadId: string;
2878
+ customerId: string;
2879
+ headers?: {
2880
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2881
+ } | undefined;
2882
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2883
+ businessFields: string[];
2884
+ company: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrBasicCompany;
2885
+ description: string;
2886
+ hoster: {
2887
+ server: string[];
2888
+ };
2889
+ languages: string[];
2890
+ leadId: string;
2891
+ mainTechnology?: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology | undefined;
2892
+ metrics: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrBasicMetrics;
2893
+ potential: number;
2894
+ scannedAt?: string | undefined;
2895
+ screenshot: string;
2896
+ technologies: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology[];
2897
+ }>;
2898
+ /** Get all leads. Use the unlocked routes for more lead details. */
2899
+ leadfyndrListLeads: (conf: {
2900
+ customerId: string;
2901
+ headers?: {
2902
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2903
+ } | undefined;
2904
+ queryParameters?: {
2905
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2906
+ potentialRangeMin?: number | undefined;
2907
+ potentialRangeMax?: number | undefined;
2908
+ employeeCountMin?: number | undefined;
2909
+ employeeCountMax?: number | undefined;
2910
+ salesVolumeMin?: number | undefined;
2911
+ salesVolumeMax?: number | undefined;
2912
+ technologies?: string[] | undefined;
2913
+ businessFields?: string[] | undefined;
2914
+ locationCity?: string | undefined;
2915
+ locationPostCode?: string | undefined;
2916
+ locationRadiusInKm?: number | undefined;
2917
+ "basic:timeToFirstByteMs:min"?: number | undefined;
2918
+ "basic:timeToFirstByteMs:max"?: number | undefined;
2919
+ "basic:desktop:performance:min"?: number | undefined;
2920
+ "basic:desktop:performance:max"?: number | undefined;
2921
+ "basic:mobile:performance:min"?: number | undefined;
2922
+ "basic:mobile:performance:max"?: number | undefined;
2923
+ limit?: number | undefined;
2924
+ skip?: number | undefined;
2925
+ page?: number | undefined;
2926
+ sort?: "potential" | "relevance" | undefined;
2927
+ order?: "asc" | "desc" | undefined;
2928
+ } | undefined;
2929
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2930
+ leads: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrLead[];
2931
+ limit: number;
2932
+ skip: number;
2933
+ totalCount: number;
2934
+ }>;
2935
+ /** Get a detail of a unlocked lead. Organisation can unlock leads. */
2936
+ leadfyndrGetUnlockedLead: (conf: {
2937
+ leadId: string;
2938
+ customerId: string;
2939
+ headers?: {
2940
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2941
+ } | undefined;
2942
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2943
+ actualUrl: string;
2944
+ businessFields: string[];
2945
+ company: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrDetailCompany;
2946
+ contact: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrContact;
2947
+ description: string;
2948
+ domain: string;
2949
+ hoster: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrHoster;
2950
+ languages: string[];
2951
+ leadId: string;
2952
+ mainTechnology?: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology | undefined;
2953
+ metrics: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrDetailMetrics;
2954
+ potential: number;
2955
+ reservationAllowed?: boolean | undefined;
2956
+ reservedAt?: string | undefined;
2957
+ scannedAt?: string | undefined;
2958
+ screenshot: string;
2959
+ socialMedia: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrSocialMedia[];
2960
+ technologies: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology[];
2961
+ unlockedAt: string;
2962
+ }>;
2963
+ /** Get all unlocked leads. Organisation can unlock leads. */
2964
+ leadfyndrListUnlockedLeads: (conf: {
2965
+ customerId: string;
2966
+ headers?: {
2967
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2968
+ } | undefined;
2969
+ queryParameters?: {
2970
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2971
+ potentialRangeMin?: number | undefined;
2972
+ potentialRangeMax?: number | undefined;
2973
+ employeeCountMin?: number | undefined;
2974
+ employeeCountMax?: number | undefined;
2975
+ salesVolumeMin?: number | undefined;
2976
+ salesVolumeMax?: number | undefined;
2977
+ technologies?: string[] | undefined;
2978
+ businessFields?: string[] | undefined;
2979
+ locationCity?: string | undefined;
2980
+ locationPostCode?: string | undefined;
2981
+ locationRadiusInKm?: number | undefined;
2982
+ "basic:timeToFirstByteMs:min"?: number | undefined;
2983
+ "basic:timeToFirstByteMs:max"?: number | undefined;
2984
+ "basic:desktop:performance:min"?: number | undefined;
2985
+ "basic:desktop:performance:max"?: number | undefined;
2986
+ "basic:mobile:performance:min"?: number | undefined;
2987
+ "basic:mobile:performance:max"?: number | undefined;
2988
+ reserved?: boolean | undefined;
2989
+ limit?: number | undefined;
2990
+ skip?: number | undefined;
2991
+ page?: number | undefined;
2992
+ sort?: "potential" | "relevance" | undefined;
2993
+ order?: "asc" | "desc" | undefined;
2994
+ } | undefined;
2995
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2996
+ leads: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrUnlockedLead[];
2997
+ limit: number;
2998
+ skip: number;
2999
+ totalCount: number;
3000
+ }>;
3001
+ /** Get lead tariff options. How many leads did you unlock this month? */
3002
+ leadfyndrGetLeadFyndrProfileTariffOptions: (conf: {
3003
+ customerId: string;
3004
+ headers?: {
3005
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3006
+ } | undefined;
3007
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3008
+ nextUnlockRenewalDate?: string | undefined;
3009
+ reservation: {
3010
+ available: number;
3011
+ tariffLimit: number;
3012
+ used: number;
3013
+ };
3014
+ unlocked: {
3015
+ available: number;
3016
+ tariffLimit: number;
3017
+ used: number;
3018
+ };
3019
+ }>;
3020
+ /** Get your LeadFyndr profile. */
3021
+ leadfyndrGetLeadFyndrProfile: (conf: {
3022
+ customerId: string;
3023
+ headers?: {
3024
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3025
+ } | undefined;
3026
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3027
+ approvedOn: string;
3028
+ customerId: string;
3029
+ disabledOn?: string | undefined;
3030
+ domain: string;
3031
+ tariff: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTariffOptions;
3032
+ }>;
3033
+ /** Get your LeadFyndr request. */
3034
+ leadfyndrGetLeadFyndrProfileRequest: (conf: {
3035
+ customerId: string;
3036
+ headers?: {
3037
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3038
+ } | undefined;
3039
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3040
+ createdOn: string;
3041
+ customerId: string;
3042
+ domain: string;
3043
+ profileId: string;
3044
+ requestedBy: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrUser;
3045
+ resultOn?: string | undefined;
3046
+ status: "AUTOTEST_INIT" | "MANUAL_VERIFICATION" | "REJECTED" | "APPROVED";
3047
+ }>;
3048
+ };
3046
3049
  export declare class MittwaldAPIV2ClientReact {
3047
3050
  /** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
3048
3051
  readonly app: ReturnType<typeof buildAppApi>;
@@ -3068,8 +3071,6 @@ export declare class MittwaldAPIV2ClientReact {
3068
3071
  readonly domain: ReturnType<typeof buildDomainApi>;
3069
3072
  /** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
3070
3073
  readonly file: ReturnType<typeof buildFileApi>;
3071
- /** The lead fyndr api allow you to manage you leads and your fyndr profile. */
3072
- readonly leadFyndr: ReturnType<typeof buildLeadFyndrApi>;
3073
3074
  /** The mail API allows you to manage your mail accounts. */
3074
3075
  readonly mail: ReturnType<typeof buildMailApi>;
3075
3076
  /** The notification API allows you to manage your notifications. */
@@ -3084,6 +3085,8 @@ export declare class MittwaldAPIV2ClientReact {
3084
3085
  readonly projectFileSystem: ReturnType<typeof buildProjectFileSystemApi>;
3085
3086
  /** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
3086
3087
  readonly sshsftpUser: ReturnType<typeof buildSshsftpUserApi>;
3088
+ /** The lead fyndr api allow you to manage you leads and your fyndr profile. */
3089
+ readonly leadFyndr: ReturnType<typeof buildLeadFyndrApi>;
3087
3090
  private constructor();
3088
3091
  static fromBaseClient(baseClient: MittwaldAPIV2Client): MittwaldAPIV2ClientReact;
3089
3092
  }