@mittwald/api-client 4.385.0 → 4.387.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.
@@ -446,6 +446,8 @@ const buildProjectApi = (baseClient) => ({
446
446
  storagespaceGetProjectStatistics: new ApiCallAsyncResourceFactory(descriptors.storagespaceGetProjectStatistics, baseClient.project.storagespaceGetProjectStatistics).getApiResource,
447
447
  /** Get storage space Statistics belonging to a Server. */
448
448
  storagespaceGetServerStatistics: new ApiCallAsyncResourceFactory(descriptors.storagespaceGetServerStatistics, baseClient.project.storagespaceGetServerStatistics).getApiResource,
449
+ /** Get the activities of a project. */
450
+ listProjectActivities: new ApiCallAsyncResourceFactory(descriptors.projectListProjectActivities, baseClient.project.listProjectActivities).getApiResource,
449
451
  });
450
452
  const buildProjectFileSystemApi = (baseClient) => ({
451
453
  /** List directories belonging to a Project. */
@@ -962,6 +962,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
962
962
  storagespaceReplaceProjectNotificationThreshold: this.requestFunctionFactory(descriptors.storagespaceReplaceProjectNotificationThreshold),
963
963
  /** Update a Server's storage space notification threshold. */
964
964
  storagespaceReplaceServerNotificationThreshold: this.requestFunctionFactory(descriptors.storagespaceReplaceServerNotificationThreshold),
965
+ /** Get the activities of a project. */
966
+ listProjectActivities: this.requestFunctionFactory(descriptors.projectListProjectActivities),
965
967
  };
966
968
  /** The filesystem API allows you to directly access the filesystem of your project. */
967
969
  projectFileSystem = {
@@ -2788,3 +2788,9 @@ export const verificationVerifyCompany = {
2788
2788
  method: "POST",
2789
2789
  operationId: "verification-verify-company",
2790
2790
  };
2791
+ /** Get the activities of a project. */
2792
+ export const projectListProjectActivities = {
2793
+ path: "/v2/projects/{projectId}/activities",
2794
+ method: "GET",
2795
+ operationId: "project-list-project-activities",
2796
+ };
@@ -1 +1 @@
1
- export const MittwaldAPIClientVersion = '4.384.0';
1
+ export const MittwaldAPIClientVersion = '4.386.0';
@@ -1732,6 +1732,7 @@ declare const buildCronjobApi: (baseClient: MittwaldAPIV2Client) => {
1732
1732
  cronjobId: string;
1733
1733
  headers?: {
1734
1734
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
1735
+ "Accept-Language"?: "de" | "en" | undefined;
1735
1736
  "x-access-token"?: string | undefined;
1736
1737
  } | undefined;
1737
1738
  }) => import("@mittwald/react-use-promise").AsyncResource<{
@@ -3481,6 +3482,27 @@ declare const buildProjectApi: (baseClient: MittwaldAPIV2Client) => {
3481
3482
  notificationThresholdInBytes?: number | undefined;
3482
3483
  statisticCategories?: import("./types.js").MittwaldAPIV2.Components.Schemas.StoragespaceStatisticsCategory[] | undefined;
3483
3484
  }>;
3485
+ /** Get the activities of a project. */
3486
+ listProjectActivities: (conf: {
3487
+ projectId: string;
3488
+ headers?: {
3489
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3490
+ } | undefined;
3491
+ queryParameters?: {
3492
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
3493
+ aggregateName?: string | undefined;
3494
+ aggregateDomain?: string | undefined;
3495
+ aggregateId?: string | undefined;
3496
+ startTime?: string | undefined;
3497
+ endTime?: string | undefined;
3498
+ fulltextSearch?: string | undefined;
3499
+ limit?: number | undefined;
3500
+ skip?: number | undefined;
3501
+ page?: number | undefined;
3502
+ sort?: "dateTime" | undefined;
3503
+ order?: "asc" | "desc" | undefined;
3504
+ } | undefined;
3505
+ }) => import("@mittwald/react-use-promise").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ActivitylogLogEntry[]>;
3484
3506
  };
3485
3507
  declare const buildProjectFileSystemApi: (baseClient: MittwaldAPIV2Client) => {
3486
3508
  /** List directories belonging to a Project. */
@@ -13808,6 +13808,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
13808
13808
  cronjobId: string;
13809
13809
  headers?: {
13810
13810
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
13811
+ "Accept-Language"?: "de" | "en" | undefined;
13811
13812
  "x-access-token"?: string | undefined;
13812
13813
  } | undefined;
13813
13814
  }, opts?: import("@mittwald/api-client-commons").RequestOptions<import("@mittwald/api-client-commons").OpenAPIOperation<{
@@ -13821,6 +13822,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
13821
13822
  };
13822
13823
  } & {
13823
13824
  headers: {
13825
+ "Accept-Language"?: "de" | "en" | undefined;
13824
13826
  "x-access-token"?: string | undefined;
13825
13827
  } & Partial<{
13826
13828
  [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
@@ -13850,6 +13852,7 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
13850
13852
  };
13851
13853
  } & {
13852
13854
  headers: {
13855
+ "Accept-Language"?: "de" | "en" | undefined;
13853
13856
  "x-access-token"?: string | undefined;
13854
13857
  } & Partial<{
13855
13858
  [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
@@ -29399,6 +29402,91 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
29399
29402
  }, 429, "application/json"> | import("@mittwald/api-client-commons").Response<{
29400
29403
  [x: string]: unknown;
29401
29404
  }, 500, "application/json">>>;
29405
+ /** Get the activities of a project. */
29406
+ listProjectActivities: (request: {
29407
+ projectId: string;
29408
+ headers?: {
29409
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
29410
+ } | undefined;
29411
+ queryParameters?: {
29412
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
29413
+ aggregateName?: string | undefined;
29414
+ aggregateDomain?: string | undefined;
29415
+ aggregateId?: string | undefined;
29416
+ startTime?: string | undefined;
29417
+ endTime?: string | undefined;
29418
+ fulltextSearch?: string | undefined;
29419
+ limit?: number | undefined;
29420
+ skip?: number | undefined;
29421
+ page?: number | undefined;
29422
+ sort?: "dateTime" | undefined;
29423
+ order?: "asc" | "desc" | undefined;
29424
+ } | undefined;
29425
+ }, opts?: import("@mittwald/api-client-commons").RequestOptions<import("@mittwald/api-client-commons").OpenAPIOperation<{
29426
+ headers?: Partial<{
29427
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
29428
+ }>;
29429
+ } & {
29430
+ pathParameters: {
29431
+ projectId: string;
29432
+ };
29433
+ } & {
29434
+ queryParameters: {
29435
+ aggregateName?: string | undefined;
29436
+ aggregateDomain?: string | undefined;
29437
+ aggregateId?: string | undefined;
29438
+ startTime?: string | undefined;
29439
+ endTime?: string | undefined;
29440
+ fulltextSearch?: string | undefined;
29441
+ limit?: number | undefined;
29442
+ skip?: number | undefined;
29443
+ page?: number | undefined;
29444
+ sort?: "dateTime" | undefined;
29445
+ order?: "asc" | "desc" | undefined;
29446
+ } & Partial<{
29447
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
29448
+ }>;
29449
+ }, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.ActivitylogLogEntry[], 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
29450
+ [x: string]: unknown;
29451
+ }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
29452
+ [x: string]: unknown;
29453
+ }, 403, "application/json"> | import("@mittwald/api-client-commons").Response<{
29454
+ [x: string]: unknown;
29455
+ }, 404, "application/json"> | import("@mittwald/api-client-commons").Response<{
29456
+ [x: string]: unknown;
29457
+ }, 429, "application/json">>> | undefined) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
29458
+ headers?: Partial<{
29459
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
29460
+ }>;
29461
+ } & {
29462
+ pathParameters: {
29463
+ projectId: string;
29464
+ };
29465
+ } & {
29466
+ queryParameters: {
29467
+ aggregateName?: string | undefined;
29468
+ aggregateDomain?: string | undefined;
29469
+ aggregateId?: string | undefined;
29470
+ startTime?: string | undefined;
29471
+ endTime?: string | undefined;
29472
+ fulltextSearch?: string | undefined;
29473
+ limit?: number | undefined;
29474
+ skip?: number | undefined;
29475
+ page?: number | undefined;
29476
+ sort?: "dateTime" | undefined;
29477
+ order?: "asc" | "desc" | undefined;
29478
+ } & Partial<{
29479
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
29480
+ }>;
29481
+ }, import("@mittwald/api-client-commons").Response<import("./types.js").MittwaldAPIV2.Components.Schemas.ActivitylogLogEntry[], 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
29482
+ [x: string]: unknown;
29483
+ }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
29484
+ [x: string]: unknown;
29485
+ }, 403, "application/json"> | import("@mittwald/api-client-commons").Response<{
29486
+ [x: string]: unknown;
29487
+ }, 404, "application/json"> | import("@mittwald/api-client-commons").Response<{
29488
+ [x: string]: unknown;
29489
+ }, 429, "application/json">>>;
29402
29490
  };
29403
29491
  /** The filesystem API allows you to directly access the filesystem of your project. */
29404
29492
  readonly projectFileSystem: {
@@ -933,3 +933,5 @@ export declare const verificationDetectPhishingEmail: OpenAPIOperation<RequestTy
933
933
  export declare const verificationVerifyAddress: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyAddress.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyAddress.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyAddress.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyAddress.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyAddress.Post.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyAddress.Post.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyAddress.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
934
934
  /** Check if a company exists. */
935
935
  export declare const verificationVerifyCompany: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Responses.$412.Content.Empty>, 412, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ActionsVerifyCompany.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
936
+ /** Get the activities of a project. */
937
+ export declare const projectListProjectActivities: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActivities.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActivities.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActivities.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActivities.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActivities.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActivities.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActivities.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActivities.Get.Responses.$429.Content.ApplicationJson>, 429, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ProjectsProjectIdActivities.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
@@ -1862,6 +1862,10 @@ export declare namespace MittwaldAPIV2 {
1862
1862
  type RequestData = InferredRequestData<typeof descriptors.verificationVerifyCompany>;
1863
1863
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.verificationVerifyCompany, TStatus>;
1864
1864
  }
1865
+ namespace ProjectListProjectActivities {
1866
+ type RequestData = InferredRequestData<typeof descriptors.projectListProjectActivities>;
1867
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.projectListProjectActivities, TStatus>;
1868
+ }
1865
1869
  }
1866
1870
  namespace Components {
1867
1871
  namespace Schemas {
@@ -5578,19 +5582,49 @@ export declare namespace MittwaldAPIV2 {
5578
5582
  machineType: string;
5579
5583
  }
5580
5584
  interface ArticleArticleAddons {
5585
+ /**
5586
+ * Defines if the Addon should not be shown.
5587
+ */
5581
5588
  hidden?: boolean;
5589
+ /**
5590
+ * Unique key of the Addon.
5591
+ */
5582
5592
  key: string;
5593
+ /**
5594
+ * The type/category of the addon.
5595
+ */
5583
5596
  type?: string;
5597
+ /**
5598
+ * Value of the Addon, e.g. configuration details, status, or modifier properties.
5599
+ */
5584
5600
  value: string;
5601
+ /**
5602
+ * Used if Articles are ordered as a batch.
5603
+ */
5585
5604
  valueMergeType?: "add" | "set";
5586
5605
  }
5587
5606
  interface ArticleArticleAttributes {
5607
+ /**
5608
+ * Used if there are custom configurations needed for an Order like a Server name.
5609
+ */
5588
5610
  customerEditable?: boolean;
5589
5611
  key: string;
5612
+ /**
5613
+ * Used if Articles are ordered as a batch.
5614
+ */
5590
5615
  mergeType?: "add" | "set";
5616
+ /**
5617
+ * Used if not need for an Order.
5618
+ */
5591
5619
  readonly?: boolean;
5592
5620
  required?: boolean;
5621
+ /**
5622
+ * Used if Articles are ordered as a batch.
5623
+ */
5593
5624
  unit?: string;
5625
+ /**
5626
+ * Will be ignored if customerEditable is set.
5627
+ */
5594
5628
  value?: string;
5595
5629
  }
5596
5630
  interface ArticleReadableBookableArticleOptions {
@@ -5641,14 +5675,32 @@ export declare namespace MittwaldAPIV2 {
5641
5675
  addons?: MittwaldAPIV2.Components.Schemas.ArticleArticleAddons[];
5642
5676
  articleId: string;
5643
5677
  attributes?: MittwaldAPIV2.Components.Schemas.ArticleArticleAttributes[];
5678
+ /**
5679
+ * @deprecated
5680
+ */
5644
5681
  balanceAddonKey?: string;
5645
5682
  contractDurationInMonth: number;
5646
5683
  description?: string;
5684
+ /**
5685
+ * If set, the Article will always be invoiced for the given months.
5686
+ */
5647
5687
  forcedInvoicingPeriodInMonth?: number;
5688
+ /**
5689
+ * Article has a contract period which is not dependent on the Contract Base Item.
5690
+ */
5648
5691
  hasIndependentContractPeriod?: boolean;
5692
+ /**
5693
+ * Free Article that is not showing on Invoices.
5694
+ */
5649
5695
  hideOnInvoice?: boolean;
5696
+ /**
5697
+ * Resources for hosting Articles.
5698
+ */
5650
5699
  machineType?: {
5651
5700
  cpu: string;
5701
+ /**
5702
+ * Memory in GiB
5703
+ */
5652
5704
  memory: string;
5653
5705
  name: string;
5654
5706
  };
@@ -5659,6 +5711,9 @@ export declare namespace MittwaldAPIV2 {
5659
5711
  */
5660
5712
  orderable: "full" | "forbidden" | "internal" | "beta_testing" | "deprecated";
5661
5713
  possibleArticleChanges?: MittwaldAPIV2.Components.Schemas.ArticleReadableChangeArticleOptions[];
5714
+ /**
5715
+ * Monthly price in Eurocent
5716
+ */
5662
5717
  price?: number;
5663
5718
  tags?: MittwaldAPIV2.Components.Schemas.ArticleArticleTag[];
5664
5719
  template: MittwaldAPIV2.Components.Schemas.ArticleArticleTemplate;
@@ -14107,7 +14162,9 @@ export declare namespace MittwaldAPIV2 {
14107
14162
  executionId: string;
14108
14163
  cronjobId: string;
14109
14164
  };
14110
- type Header = {} & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
14165
+ type Header = {
14166
+ "Accept-Language"?: "de" | "en";
14167
+ } & MittwaldAPIV2.Components.SecuritySchemes.CommonsAccessToken;
14111
14168
  type Query = {};
14112
14169
  }
14113
14170
  namespace Responses {
@@ -30701,5 +30758,70 @@ export declare namespace MittwaldAPIV2 {
30701
30758
  }
30702
30759
  }
30703
30760
  }
30761
+ namespace V2ProjectsProjectIdActivities {
30762
+ namespace Get {
30763
+ namespace Parameters {
30764
+ type Path = {
30765
+ projectId: string;
30766
+ };
30767
+ type Header = {};
30768
+ type Query = {
30769
+ aggregateName?: string;
30770
+ aggregateDomain?: string;
30771
+ aggregateId?: string;
30772
+ startTime?: string;
30773
+ endTime?: string;
30774
+ fulltextSearch?: string;
30775
+ limit?: number;
30776
+ skip?: number;
30777
+ page?: number;
30778
+ sort?: "dateTime";
30779
+ order?: "asc" | "desc";
30780
+ };
30781
+ }
30782
+ namespace Responses {
30783
+ namespace $200 {
30784
+ namespace Content {
30785
+ type ApplicationJson = MittwaldAPIV2.Components.Schemas.ActivitylogLogEntry[];
30786
+ }
30787
+ }
30788
+ namespace $400 {
30789
+ namespace Content {
30790
+ interface ApplicationJson {
30791
+ [k: string]: unknown;
30792
+ }
30793
+ }
30794
+ }
30795
+ namespace $403 {
30796
+ namespace Content {
30797
+ interface ApplicationJson {
30798
+ [k: string]: unknown;
30799
+ }
30800
+ }
30801
+ }
30802
+ namespace $404 {
30803
+ namespace Content {
30804
+ interface ApplicationJson {
30805
+ [k: string]: unknown;
30806
+ }
30807
+ }
30808
+ }
30809
+ namespace $429 {
30810
+ namespace Content {
30811
+ interface ApplicationJson {
30812
+ [k: string]: unknown;
30813
+ }
30814
+ }
30815
+ }
30816
+ namespace Default {
30817
+ namespace Content {
30818
+ interface ApplicationJson {
30819
+ [k: string]: unknown;
30820
+ }
30821
+ }
30822
+ }
30823
+ }
30824
+ }
30825
+ }
30704
30826
  }
30705
30827
  }
@@ -1 +1 @@
1
- export declare const MittwaldAPIClientVersion = '4.384.0';
1
+ export declare const MittwaldAPIClientVersion = '4.386.0';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mittwald/api-client",
3
- "version": "4.385.0",
3
+ "version": "4.387.0",
4
4
  "author": "Mittwald CM Service GmbH & Co. KG <opensource@mittwald.de>",
5
5
  "type": "module",
6
6
  "description": "Auto-generated client for the mittwald API",
@@ -46,11 +46,11 @@
46
46
  "test:compile": "run tsc --noEmit"
47
47
  },
48
48
  "dependencies": {
49
- "@mittwald/api-client-commons": "^4.385.0",
49
+ "@mittwald/api-client-commons": "^4.387.0",
50
50
  "browser-or-node": "^3.0.0"
51
51
  },
52
52
  "devDependencies": {
53
- "@mittwald/api-code-generator": "^4.385.0",
53
+ "@mittwald/api-code-generator": "^4.387.0",
54
54
  "@mittwald/react-use-promise": "^2.6.2",
55
55
  "@types/node": "^22.18.11",
56
56
  "@types/react": "^18.3.26",
@@ -80,5 +80,5 @@
80
80
  "optional": true
81
81
  }
82
82
  },
83
- "gitHead": "1802e5eb9a15e6177dcd3c90969c102574e7cc8d"
83
+ "gitHead": "0dc69cd0f26e93c307dc6e465abb8f10fccc3232"
84
84
  }