@mittwald/api-client 4.170.0 → 4.172.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: {
@@ -2882,6 +2700,30 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
2882
2700
  notificationThresholdInBytes?: number | undefined;
2883
2701
  statisticCategories?: import("./types.js").MittwaldAPIV2.Components.Schemas.StoragespaceStatisticsCategory[] | undefined;
2884
2702
  }>;
2703
+ /** Get a list of already created llm licences. */
2704
+ getLlmLicencesExperimental: (conf: {
2705
+ projectId: string;
2706
+ headers?: {
2707
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2708
+ } | undefined;
2709
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.LlmlocksmithLicence[]>;
2710
+ /** Get a licence of a project. */
2711
+ getLlmLicenceExperimental: (conf: {
2712
+ projectId: string;
2713
+ licenceId: string;
2714
+ headers?: {
2715
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2716
+ } | undefined;
2717
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2718
+ containerMeta?: import("./types.js").MittwaldAPIV2.Components.Schemas.LlmlocksmithContainerMeta | undefined;
2719
+ customerId?: string | undefined;
2720
+ licenceId: string;
2721
+ licenceKey: string;
2722
+ models: string[];
2723
+ name: string;
2724
+ projectId?: string | undefined;
2725
+ rateLimit: number;
2726
+ }>;
2885
2727
  };
2886
2728
  declare const buildProjectFileSystemApi: (baseClient: MittwaldAPIV2Client) => {
2887
2729
  /** List directories belonging to a Project. */
@@ -3043,6 +2885,191 @@ declare const buildSshsftpUserApi: (baseClient: MittwaldAPIV2Client) => {
3043
2885
  userName: string;
3044
2886
  }>;
3045
2887
  };
2888
+ declare const buildLeadFyndrApi: (baseClient: MittwaldAPIV2Client) => {
2889
+ /** Get cities in DACH. */
2890
+ leadfyndrGetCities: (conf: {
2891
+ queryParameters: {
2892
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2893
+ input: string;
2894
+ };
2895
+ headers?: {
2896
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2897
+ } | undefined;
2898
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrCity[]>;
2899
+ /** Get a simple lead. Use the unlocked route for more detail leads. */
2900
+ leadfyndrGetLead: (conf: {
2901
+ leadId: string;
2902
+ customerId: string;
2903
+ headers?: {
2904
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2905
+ } | undefined;
2906
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2907
+ businessFields: string[];
2908
+ company: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrBasicCompany;
2909
+ description: string;
2910
+ hoster: {
2911
+ server: string[];
2912
+ };
2913
+ languages: string[];
2914
+ leadId: string;
2915
+ mainTechnology?: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology | undefined;
2916
+ metrics: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrBasicMetrics;
2917
+ potential: number;
2918
+ scannedAt?: string | undefined;
2919
+ screenshot: string;
2920
+ technologies: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology[];
2921
+ }>;
2922
+ /** Get all leads. Use the unlocked routes for more lead details. */
2923
+ leadfyndrListLeads: (conf: {
2924
+ customerId: string;
2925
+ headers?: {
2926
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2927
+ } | undefined;
2928
+ queryParameters?: {
2929
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2930
+ potentialRangeMin?: number | undefined;
2931
+ potentialRangeMax?: number | undefined;
2932
+ employeeCountMin?: number | undefined;
2933
+ employeeCountMax?: number | undefined;
2934
+ salesVolumeMin?: number | undefined;
2935
+ salesVolumeMax?: number | undefined;
2936
+ technologies?: string[] | undefined;
2937
+ businessFields?: string[] | undefined;
2938
+ locationCity?: string | undefined;
2939
+ locationPostCode?: string | undefined;
2940
+ locationRadiusInKm?: number | undefined;
2941
+ "basic:timeToFirstByteMs:min"?: number | undefined;
2942
+ "basic:timeToFirstByteMs:max"?: number | undefined;
2943
+ "basic:desktop:performance:min"?: number | undefined;
2944
+ "basic:desktop:performance:max"?: number | undefined;
2945
+ "basic:mobile:performance:min"?: number | undefined;
2946
+ "basic:mobile:performance:max"?: number | undefined;
2947
+ limit?: number | undefined;
2948
+ skip?: number | undefined;
2949
+ page?: number | undefined;
2950
+ sort?: "potential" | "relevance" | undefined;
2951
+ order?: "asc" | "desc" | undefined;
2952
+ } | undefined;
2953
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2954
+ leads: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrLead[];
2955
+ limit: number;
2956
+ skip: number;
2957
+ totalCount: number;
2958
+ }>;
2959
+ /** Get a detail of a unlocked lead. Organisation can unlock leads. */
2960
+ leadfyndrGetUnlockedLead: (conf: {
2961
+ leadId: string;
2962
+ customerId: string;
2963
+ headers?: {
2964
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2965
+ } | undefined;
2966
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2967
+ actualUrl: string;
2968
+ businessFields: string[];
2969
+ company: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrDetailCompany;
2970
+ contact: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrContact;
2971
+ description: string;
2972
+ domain: string;
2973
+ hoster: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrHoster;
2974
+ languages: string[];
2975
+ leadId: string;
2976
+ mainTechnology?: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology | undefined;
2977
+ metrics: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrDetailMetrics;
2978
+ potential: number;
2979
+ reservationAllowed?: boolean | undefined;
2980
+ reservedAt?: string | undefined;
2981
+ scannedAt?: string | undefined;
2982
+ screenshot: string;
2983
+ socialMedia: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrSocialMedia[];
2984
+ technologies: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTechnology[];
2985
+ unlockedAt: string;
2986
+ }>;
2987
+ /** Get all unlocked leads. Organisation can unlock leads. */
2988
+ leadfyndrListUnlockedLeads: (conf: {
2989
+ customerId: string;
2990
+ headers?: {
2991
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2992
+ } | undefined;
2993
+ queryParameters?: {
2994
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2995
+ potentialRangeMin?: number | undefined;
2996
+ potentialRangeMax?: number | undefined;
2997
+ employeeCountMin?: number | undefined;
2998
+ employeeCountMax?: number | undefined;
2999
+ salesVolumeMin?: number | undefined;
3000
+ salesVolumeMax?: number | undefined;
3001
+ technologies?: string[] | undefined;
3002
+ businessFields?: string[] | undefined;
3003
+ locationCity?: string | undefined;
3004
+ locationPostCode?: string | undefined;
3005
+ locationRadiusInKm?: number | undefined;
3006
+ "basic:timeToFirstByteMs:min"?: number | undefined;
3007
+ "basic:timeToFirstByteMs:max"?: number | undefined;
3008
+ "basic:desktop:performance:min"?: number | undefined;
3009
+ "basic:desktop:performance:max"?: number | undefined;
3010
+ "basic:mobile:performance:min"?: number | undefined;
3011
+ "basic:mobile:performance:max"?: number | undefined;
3012
+ reserved?: boolean | undefined;
3013
+ limit?: number | undefined;
3014
+ skip?: number | undefined;
3015
+ page?: number | undefined;
3016
+ sort?: "potential" | "relevance" | undefined;
3017
+ order?: "asc" | "desc" | undefined;
3018
+ } | undefined;
3019
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3020
+ leads: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrUnlockedLead[];
3021
+ limit: number;
3022
+ skip: number;
3023
+ totalCount: number;
3024
+ }>;
3025
+ /** Get lead tariff options. How many leads did you unlock this month? */
3026
+ leadfyndrGetLeadFyndrProfileTariffOptions: (conf: {
3027
+ customerId: string;
3028
+ headers?: {
3029
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3030
+ } | undefined;
3031
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3032
+ nextUnlockRenewalDate?: string | undefined;
3033
+ reservation: {
3034
+ available: number;
3035
+ tariffLimit: number;
3036
+ used: number;
3037
+ };
3038
+ unlocked: {
3039
+ available: number;
3040
+ tariffLimit: number;
3041
+ used: number;
3042
+ };
3043
+ }>;
3044
+ /** Get your LeadFyndr profile. */
3045
+ leadfyndrGetLeadFyndrProfile: (conf: {
3046
+ customerId: string;
3047
+ headers?: {
3048
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3049
+ } | undefined;
3050
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3051
+ approvedOn: string;
3052
+ customerId: string;
3053
+ disabledOn?: string | undefined;
3054
+ domain: string;
3055
+ tariff: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrTariffOptions;
3056
+ }>;
3057
+ /** Get your LeadFyndr request. */
3058
+ leadfyndrGetLeadFyndrProfileRequest: (conf: {
3059
+ customerId: string;
3060
+ headers?: {
3061
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3062
+ } | undefined;
3063
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
3064
+ createdOn: string;
3065
+ customerId: string;
3066
+ domain: string;
3067
+ profileId: string;
3068
+ requestedBy: import("./types.js").MittwaldAPIV2.Components.Schemas.LeadfyndrUser;
3069
+ resultOn?: string | undefined;
3070
+ status: "AUTOTEST_INIT" | "MANUAL_VERIFICATION" | "REJECTED" | "APPROVED";
3071
+ }>;
3072
+ };
3046
3073
  export declare class MittwaldAPIV2ClientReact {
3047
3074
  /** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
3048
3075
  readonly app: ReturnType<typeof buildAppApi>;
@@ -3068,8 +3095,6 @@ export declare class MittwaldAPIV2ClientReact {
3068
3095
  readonly domain: ReturnType<typeof buildDomainApi>;
3069
3096
  /** The file API allows you to manage your files, for example for conversations attachments and avatar uploads. */
3070
3097
  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
3098
  /** The mail API allows you to manage your mail accounts. */
3074
3099
  readonly mail: ReturnType<typeof buildMailApi>;
3075
3100
  /** The notification API allows you to manage your notifications. */
@@ -3084,6 +3109,8 @@ export declare class MittwaldAPIV2ClientReact {
3084
3109
  readonly projectFileSystem: ReturnType<typeof buildProjectFileSystemApi>;
3085
3110
  /** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
3086
3111
  readonly sshsftpUser: ReturnType<typeof buildSshsftpUserApi>;
3112
+ /** The lead fyndr api allow you to manage you leads and your fyndr profile. */
3113
+ readonly leadFyndr: ReturnType<typeof buildLeadFyndrApi>;
3087
3114
  private constructor();
3088
3115
  static fromBaseClient(baseClient: MittwaldAPIV2Client): MittwaldAPIV2ClientReact;
3089
3116
  }