@mittwald/api-client 4.183.0 → 4.185.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.
@@ -116,8 +116,12 @@ const buildMarketplaceApi = (baseClient) => ({
116
116
  contributorGetLoginLink: new ApiCallAsyncResourceFactory(descriptors.contributorGetLoginLink, baseClient.marketplace.contributorGetLoginLink).getApiResource,
117
117
  /** List ContractPartners of the contributor. */
118
118
  contributorListContractPartnersOfContributor: new ApiCallAsyncResourceFactory(descriptors.contributorListContractPartnersOfContributor, baseClient.marketplace.contributorListContractPartnersOfContributor).getApiResource,
119
+ /** List incoming Invoices of a Contributor. */
120
+ contributorListIncomingInvoices: new ApiCallAsyncResourceFactory(descriptors.contributorListIncomingInvoices, baseClient.marketplace.contributorListIncomingInvoices).getApiResource,
119
121
  /** List all invoices on behalf of a contributor. */
120
122
  contributorListOnbehalfInvoices: new ApiCallAsyncResourceFactory(descriptors.contributorListOnbehalfInvoices, baseClient.marketplace.contributorListOnbehalfInvoices).getApiResource,
123
+ /** Request an Access Token for the Incoming Invoice file. */
124
+ contributorReceiptGetFileAccessToken: new ApiCallAsyncResourceFactory(descriptors.contributorReceiptGetFileAccessToken, baseClient.marketplace.contributorReceiptGetFileAccessToken).getApiResource,
121
125
  /** List ExtensionInstances. */
122
126
  extensionListExtensionInstances: new ApiCallAsyncResourceFactory(descriptors.extensionListExtensionInstances, baseClient.marketplace.extensionListExtensionInstances).getApiResource,
123
127
  /** Get an ExtensionInstance. */
@@ -297,6 +301,10 @@ const buildMailApi = (baseClient) => ({
297
301
  /** List mail settings of a Project. */
298
302
  listProjectMailSettings: new ApiCallAsyncResourceFactory(descriptors.mailListProjectMailSettings, baseClient.mail.listProjectMailSettings).getApiResource,
299
303
  });
304
+ const buildMiscApi = (baseClient) => ({
305
+ /** Get a list of currently active llm models. */
306
+ getLlmModelsExperimental: new ApiCallAsyncResourceFactory(descriptors.miscGetLlmModelsExperimental, baseClient.misc.getLlmModelsExperimental).getApiResource,
307
+ });
300
308
  const buildNotificationApi = (baseClient) => ({
301
309
  /** Getting the subscription status of the subscription. */
302
310
  newsletterGetInfo: new ApiCallAsyncResourceFactory(descriptors.newsletterGetInfo, baseClient.notification.newsletterGetInfo).getApiResource,
@@ -348,6 +356,8 @@ const buildUserApi = (baseClient) => ({
348
356
  supportCodeRequest: new ApiCallAsyncResourceFactory(descriptors.userSupportCodeRequest, baseClient.user.supportCodeRequest).getApiResource,
349
357
  });
350
358
  const buildProjectApi = (baseClient) => ({
359
+ /** Get a list of already created llm licences. */
360
+ getLlmLicencesExperimental: new ApiCallAsyncResourceFactory(descriptors.projectGetLlmLicencesExperimental, baseClient.project.getLlmLicencesExperimental).getApiResource,
351
361
  /** List Invites belonging to a Project. */
352
362
  listInvitesForProject: new ApiCallAsyncResourceFactory(descriptors.projectListInvitesForProject, baseClient.project.listInvitesForProject).getApiResource,
353
363
  /** Get a ProjectInvite. */
@@ -356,6 +366,8 @@ const buildProjectApi = (baseClient) => ({
356
366
  getProjectMembership: new ApiCallAsyncResourceFactory(descriptors.projectGetProjectMembership, baseClient.project.getProjectMembership).getApiResource,
357
367
  /** Get a Project. */
358
368
  getProject: new ApiCallAsyncResourceFactory(descriptors.projectGetProject, baseClient.project.getProject).getApiResource,
369
+ /** Get a licence of a project. */
370
+ getLlmLicenceExperimental: new ApiCallAsyncResourceFactory(descriptors.projectGetLlmLicenceExperimental, baseClient.project.getLlmLicenceExperimental).getApiResource,
359
371
  /** Get a ProjectInvite by token. */
360
372
  getProjectTokenInvite: new ApiCallAsyncResourceFactory(descriptors.projectGetProjectTokenInvite, baseClient.project.getProjectTokenInvite).getApiResource,
361
373
  /** Get the executing user's membership in a Project. */
@@ -428,6 +440,8 @@ export class MittwaldAPIV2ClientReact {
428
440
  leadFyndr;
429
441
  /** The mail API allows you to manage your mail accounts. */
430
442
  mail;
443
+ /** API endpoints that are not related to any specific API domain */
444
+ misc;
431
445
  /** The notification API allows you to manage your notifications. */
432
446
  notification;
433
447
  /** The page insights API allows you to get page insights information. */
@@ -455,6 +469,7 @@ export class MittwaldAPIV2ClientReact {
455
469
  this.file = buildFileApi(baseClient);
456
470
  this.leadFyndr = buildLeadFyndrApi(baseClient);
457
471
  this.mail = buildMailApi(baseClient);
472
+ this.misc = buildMiscApi(baseClient);
458
473
  this.notification = buildNotificationApi(baseClient);
459
474
  this.pageInsights = buildPageInsightsApi(baseClient);
460
475
  this.user = buildUserApi(baseClient);
@@ -207,8 +207,12 @@ export class MittwaldAPIV2Client extends ApiClientBase {
207
207
  contributorGetLoginLink: this.requestFunctionFactory(descriptors.contributorGetLoginLink),
208
208
  /** List ContractPartners of the contributor. */
209
209
  contributorListContractPartnersOfContributor: this.requestFunctionFactory(descriptors.contributorListContractPartnersOfContributor),
210
+ /** List incoming Invoices of a Contributor. */
211
+ contributorListIncomingInvoices: this.requestFunctionFactory(descriptors.contributorListIncomingInvoices),
210
212
  /** List all invoices on behalf of a contributor. */
211
213
  contributorListOnbehalfInvoices: this.requestFunctionFactory(descriptors.contributorListOnbehalfInvoices),
214
+ /** Request an Access Token for the Incoming Invoice file. */
215
+ contributorReceiptGetFileAccessToken: this.requestFunctionFactory(descriptors.contributorReceiptGetFileAccessToken),
212
216
  /** Rotate the secret for an extension instance. */
213
217
  contributorRotateSecretForExtensionInstance: this.requestFunctionFactory(descriptors.contributorRotateSecretForExtensionInstance),
214
218
  /** Authenticate your external application using the extensionInstanceSecret. */
@@ -754,6 +758,19 @@ export class MittwaldAPIV2Client extends ApiClientBase {
754
758
  /** Removes a reservation on a unlocked lead for the given customerId. */
755
759
  leadfyndrRemoveUnlockedLeadReservation: this.requestFunctionFactory(descriptors.leadfyndrRemoveUnlockedLeadReservation),
756
760
  };
761
+ /** API endpoints that are not related to any specific API domain */
762
+ misc = {
763
+ /** Get a list of currently active llm models. */
764
+ getLlmModelsExperimental: this.requestFunctionFactory(descriptors.miscGetLlmModelsExperimental),
765
+ /** Obtain a service token. */
766
+ servicetokenAuthenticateService: this.requestFunctionFactory(descriptors.servicetokenAuthenticateService),
767
+ /** Check if an address exists. */
768
+ verificationVerifyAddress: this.requestFunctionFactory(descriptors.verificationVerifyAddress),
769
+ /** Check if a company exists. */
770
+ verificationVerifyCompany: this.requestFunctionFactory(descriptors.verificationVerifyCompany),
771
+ /** Check if an email is from mittwald. */
772
+ verificationDetectPhishingEmail: this.requestFunctionFactory(descriptors.verificationDetectPhishingEmail),
773
+ };
757
774
  /** The page insights API allows you to get page insights information. */
758
775
  pageInsights = {
759
776
  /** Get detailed performance data for a given domain and path. */
@@ -769,6 +786,10 @@ export class MittwaldAPIV2Client extends ApiClientBase {
769
786
  project = {
770
787
  /** Accept a ProjectInvite. */
771
788
  acceptProjectInvite: this.requestFunctionFactory(descriptors.projectAcceptProjectInvite),
789
+ /** Get a list of already created llm licences. */
790
+ getLlmLicencesExperimental: this.requestFunctionFactory(descriptors.projectGetLlmLicencesExperimental),
791
+ /** Creates a new llm beta Licence for a project. Will be purged on end of beta. */
792
+ createLlmBetaLicenceExperimental: this.requestFunctionFactory(descriptors.projectCreateLlmBetaLicenceExperimental),
772
793
  /** List Invites belonging to a Project. */
773
794
  listInvitesForProject: this.requestFunctionFactory(descriptors.projectListInvitesForProject),
774
795
  /** Create a ProjectInvite. */
@@ -799,6 +820,10 @@ export class MittwaldAPIV2Client extends ApiClientBase {
799
820
  requestServerAvatarUpload: this.requestFunctionFactory(descriptors.projectRequestServerAvatarUpload),
800
821
  /** Delete a Server's avatar. */
801
822
  deleteServerAvatar: this.requestFunctionFactory(descriptors.projectDeleteServerAvatar),
823
+ /** Get a licence of a project. */
824
+ getLlmLicenceExperimental: this.requestFunctionFactory(descriptors.projectGetLlmLicenceExperimental),
825
+ /** Update a llm Licence for a project. */
826
+ updateLlmLicenceExperimental: this.requestFunctionFactory(descriptors.projectUpdateLlmLicenceExperimental),
802
827
  /** Get a ProjectInvite by token. */
803
828
  getProjectTokenInvite: this.requestFunctionFactory(descriptors.projectGetProjectTokenInvite),
804
829
  /** Get the executing user's membership in a Project. */
@@ -850,15 +875,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
850
875
  /** Relocate an external Project to mittwald. */
851
876
  createRelocation: this.requestFunctionFactory(descriptors.relocationCreateRelocation),
852
877
  };
853
- /** API endpoints that are not related to any specific API domain */
854
- misc = {
855
- /** Obtain a service token. */
856
- servicetokenAuthenticateService: this.requestFunctionFactory(descriptors.servicetokenAuthenticateService),
857
- /** Check if an address exists. */
858
- verificationVerifyAddress: this.requestFunctionFactory(descriptors.verificationVerifyAddress),
859
- /** Check if a company exists. */
860
- verificationVerifyCompany: this.requestFunctionFactory(descriptors.verificationVerifyCompany),
861
- };
862
878
  /** The SSH/SFTP User API allows you to manage your SSH/SFTP users within a project. */
863
879
  sshsftpUser = {
864
880
  /** Get all SFTPUsers for a Project. */
@@ -478,12 +478,24 @@ export const contributorListContractPartnersOfContributor = {
478
478
  method: "GET",
479
479
  operationId: "contributor-list-contract-partners-of-contributor",
480
480
  };
481
+ /** List incoming Invoices of a Contributor. */
482
+ export const contributorListIncomingInvoices = {
483
+ path: "/v2/contributors/{contributorId}/invoices/incoming",
484
+ method: "GET",
485
+ operationId: "contributor-list-incoming-invoices",
486
+ };
481
487
  /** List all invoices on behalf of a contributor. */
482
488
  export const contributorListOnbehalfInvoices = {
483
489
  path: "/v2/contributors/{contributorId}/invoices/outgoing",
484
490
  method: "GET",
485
491
  operationId: "contributor-list-onbehalf-invoices",
486
492
  };
493
+ /** Request an Access Token for the Incoming Invoice file. */
494
+ export const contributorReceiptGetFileAccessToken = {
495
+ path: "/v2/contributors/{contributorId}/invoices/incoming/{contributorReceiptId}/file-access-token",
496
+ method: "GET",
497
+ operationId: "contributor-receipt-get-file-access-token",
498
+ };
487
499
  /** Rotate the secret for an extension instance. */
488
500
  export const contributorRotateSecretForExtensionInstance = {
489
501
  path: "/v2/contributors/{contributorId}/extensions/{extensionId}/extension-instances/{extensionInstanceId}/secret",
@@ -1648,6 +1660,12 @@ export const marketplaceCustomerUpdatePaymentMethod = {
1648
1660
  method: "PUT",
1649
1661
  operationId: "marketplace-customer-update-payment-method",
1650
1662
  };
1663
+ /** Get a list of currently active llm models. */
1664
+ export const miscGetLlmModelsExperimental = {
1665
+ path: "/experimental-v2/llm-models",
1666
+ method: "GET",
1667
+ operationId: "misc-get-llm-models-experimental",
1668
+ };
1651
1669
  /** Getting the subscription status of the subscription. */
1652
1670
  export const newsletterGetInfo = {
1653
1671
  path: "/v2/newsletter-subscriptions/self",
@@ -1768,6 +1786,18 @@ export const projectAcceptProjectInvite = {
1768
1786
  method: "POST",
1769
1787
  operationId: "project-accept-project-invite",
1770
1788
  };
1789
+ /** Get a list of already created llm licences. */
1790
+ export const projectGetLlmLicencesExperimental = {
1791
+ path: "/experimental-v2/projects/{projectId}/llm-licences",
1792
+ method: "GET",
1793
+ operationId: "project-get-llm-licences-experimental",
1794
+ };
1795
+ /** Creates a new llm beta Licence for a project. Will be purged on end of beta. */
1796
+ export const projectCreateLlmBetaLicenceExperimental = {
1797
+ path: "/experimental-v2/projects/{projectId}/llm-licences",
1798
+ method: "POST",
1799
+ operationId: "project-create-llm-beta-licence-experimental",
1800
+ };
1771
1801
  /** List Invites belonging to a Project. */
1772
1802
  export const projectListInvitesForProject = {
1773
1803
  path: "/v2/projects/{projectId}/invites",
@@ -1888,6 +1918,18 @@ export const projectFileSystemListFiles = {
1888
1918
  method: "GET",
1889
1919
  operationId: "project-file-system-list-files",
1890
1920
  };
1921
+ /** Get a licence of a project. */
1922
+ export const projectGetLlmLicenceExperimental = {
1923
+ path: "/experimental-v2/projects/{projectId}/llm-licences/{licenceId}",
1924
+ method: "GET",
1925
+ operationId: "project-get-llm-licence-experimental",
1926
+ };
1927
+ /** Update a llm Licence for a project. */
1928
+ export const projectUpdateLlmLicenceExperimental = {
1929
+ path: "/experimental-v2/projects/{projectId}/llm-licences/{licenceId}",
1930
+ method: "PUT",
1931
+ operationId: "project-update-llm-licence-experimental",
1932
+ };
1891
1933
  /** Get a ProjectInvite by token. */
1892
1934
  export const projectGetProjectTokenInvite = {
1893
1935
  path: "/v2/project-token-invite",
@@ -2434,3 +2476,9 @@ export const verificationVerifyCompany = {
2434
2476
  method: "POST",
2435
2477
  operationId: "verification-verify-company",
2436
2478
  };
2479
+ /** Check if an email is from mittwald. */
2480
+ export const verificationDetectPhishingEmail = {
2481
+ path: "/v2/actions/detect-phishing-email",
2482
+ method: "POST",
2483
+ operationId: "verification-detect-phishing-email",
2484
+ };
@@ -1 +1 @@
1
- export const MittwaldAPIClientVersion = '4.182.0';
1
+ export const MittwaldAPIClientVersion = '4.184.0';
@@ -876,6 +876,26 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
876
876
  extensionInstanceId?: string | undefined;
877
877
  } | undefined;
878
878
  }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.MarketplaceContractPartner[]>;
879
+ /** List incoming Invoices of a Contributor. */
880
+ contributorListIncomingInvoices: (conf: {
881
+ contributorId: string;
882
+ headers?: {
883
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
884
+ "x-access-token"?: string | undefined;
885
+ } | undefined;
886
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
887
+ currency: string;
888
+ customerId: string;
889
+ customerName: string;
890
+ customerNumber: string;
891
+ date: string;
892
+ id: string;
893
+ invoiceNumber: string;
894
+ pdfId: string;
895
+ recipient: import("./types.js").MittwaldAPIV2.Components.Schemas.InvoiceRecipient;
896
+ totalGross: number;
897
+ totalNet: number;
898
+ }[]>;
879
899
  /** List all invoices on behalf of a contributor. */
880
900
  contributorListOnbehalfInvoices: (conf: {
881
901
  contributorId: string;
@@ -892,6 +912,18 @@ declare const buildMarketplaceApi: (baseClient: MittwaldAPIV2Client) => {
892
912
  totalNet: number;
893
913
  webLink: string;
894
914
  }[]>;
915
+ /** Request an Access Token for the Incoming Invoice file. */
916
+ contributorReceiptGetFileAccessToken: (conf: {
917
+ contributorId: string;
918
+ contributorReceiptId: string;
919
+ headers?: {
920
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
921
+ "x-access-token"?: string | undefined;
922
+ } | undefined;
923
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
924
+ accessToken: string;
925
+ expiresAt: string;
926
+ }>;
895
927
  /** List ExtensionInstances. */
896
928
  extensionListExtensionInstances: (conf?: {
897
929
  headers?: {
@@ -2286,6 +2318,14 @@ declare const buildMailApi: (baseClient: MittwaldAPIV2Client) => {
2286
2318
  whitelist: string[];
2287
2319
  }>;
2288
2320
  };
2321
+ declare const buildMiscApi: (baseClient: MittwaldAPIV2Client) => {
2322
+ /** Get a list of currently active llm models. */
2323
+ getLlmModelsExperimental: (conf?: {
2324
+ headers?: {
2325
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2326
+ } | undefined;
2327
+ } | null | undefined) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.LlmlocksmithModel[]>;
2328
+ };
2289
2329
  declare const buildNotificationApi: (baseClient: MittwaldAPIV2Client) => {
2290
2330
  /** Getting the subscription status of the subscription. */
2291
2331
  newsletterGetInfo: (conf?: {
@@ -2605,6 +2645,13 @@ declare const buildUserApi: (baseClient: MittwaldAPIV2Client) => {
2605
2645
  }>;
2606
2646
  };
2607
2647
  declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
2648
+ /** Get a list of already created llm licences. */
2649
+ getLlmLicencesExperimental: (conf: {
2650
+ projectId: string;
2651
+ headers?: {
2652
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2653
+ } | undefined;
2654
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.LlmlocksmithLicence[]>;
2608
2655
  /** List Invites belonging to a Project. */
2609
2656
  listInvitesForProject: (conf: {
2610
2657
  projectId: string;
@@ -2695,6 +2742,23 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
2695
2742
  webStorageUsageInBytes: number;
2696
2743
  webStorageUsageInBytesSetAt: string;
2697
2744
  }>;
2745
+ /** Get a licence of a project. */
2746
+ getLlmLicenceExperimental: (conf: {
2747
+ projectId: string;
2748
+ licenceId: string;
2749
+ headers?: {
2750
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2751
+ } | undefined;
2752
+ }) => import("@mittwald/react-use-promise").AsyncResource<{
2753
+ containerMeta?: import("./types.js").MittwaldAPIV2.Components.Schemas.LlmlocksmithContainerMeta | undefined;
2754
+ customerId?: string | undefined;
2755
+ licenceId: string;
2756
+ licenceKey: string;
2757
+ models: string[];
2758
+ name: string;
2759
+ projectId?: string | undefined;
2760
+ rateLimit: number;
2761
+ }>;
2698
2762
  /** Get a ProjectInvite by token. */
2699
2763
  getProjectTokenInvite: (conf: {
2700
2764
  headers: {
@@ -3080,6 +3144,8 @@ export declare class MittwaldAPIV2ClientReact {
3080
3144
  readonly leadFyndr: ReturnType<typeof buildLeadFyndrApi>;
3081
3145
  /** The mail API allows you to manage your mail accounts. */
3082
3146
  readonly mail: ReturnType<typeof buildMailApi>;
3147
+ /** API endpoints that are not related to any specific API domain */
3148
+ readonly misc: ReturnType<typeof buildMiscApi>;
3083
3149
  /** The notification API allows you to manage your notifications. */
3084
3150
  readonly notification: ReturnType<typeof buildNotificationApi>;
3085
3151
  /** The page insights API allows you to get page insights information. */