@mittwald/api-client 4.333.0 → 4.334.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.
@@ -70,6 +70,8 @@ const buildBackupApi = (baseClient) => ({
70
70
  getProjectBackupDirectories: new ApiCallAsyncResourceFactory(descriptors.backupGetProjectBackupDirectories, baseClient.backup.getProjectBackupDirectories).getApiResource,
71
71
  });
72
72
  const buildContainerApi = (baseClient) => ({
73
+ /** Call pull-image webhook */
74
+ callPullImageWebhookForService: new ApiCallAsyncResourceFactory(descriptors.containerCallPullImageWebhookForService, baseClient.container.callPullImageWebhookForService).getApiResource,
73
75
  /** List Registries belonging to a Project. */
74
76
  listRegistries: new ApiCallAsyncResourceFactory(descriptors.containerListRegistries, baseClient.container.listRegistries).getApiResource,
75
77
  /** Get a Stack. */
@@ -218,28 +220,28 @@ const buildCronjobApi = (baseClient) => ({
218
220
  getExecution: new ApiCallAsyncResourceFactory(descriptors.cronjobGetExecution, baseClient.cronjob.getExecution).getApiResource,
219
221
  });
220
222
  const buildCustomerApi = (baseClient) => ({
223
+ /** List Invites belonging to a Customer. */
224
+ listInvitesForCustomer: new ApiCallAsyncResourceFactory(descriptors.customerListInvitesForCustomer, baseClient.customer.listInvitesForCustomer).getApiResource,
221
225
  /** Get all customer profiles the authenticated user has access to. */
222
226
  listCustomers: new ApiCallAsyncResourceFactory(descriptors.customerListCustomers, baseClient.customer.listCustomers).getApiResource,
223
227
  /** Gets the Wallet of the Customer. */
224
228
  getWallet: new ApiCallAsyncResourceFactory(descriptors.customerGetWallet, baseClient.customer.getWallet).getApiResource,
225
- /** Get a customer profile. */
226
- getCustomer: new ApiCallAsyncResourceFactory(descriptors.customerGetCustomer, baseClient.customer.getCustomer).getApiResource,
227
- /** Check if the customer profile has a valid contract partner configured. */
228
- isCustomerLegallyCompetent: new ApiCallAsyncResourceFactory(descriptors.customerIsCustomerLegallyCompetent, baseClient.customer.isCustomerLegallyCompetent).getApiResource,
229
229
  /** Get a CustomerInvite. */
230
230
  getCustomerInvite: new ApiCallAsyncResourceFactory(descriptors.customerGetCustomerInvite, baseClient.customer.getCustomerInvite).getApiResource,
231
231
  /** Get a CustomerMembership. */
232
232
  getCustomerMembership: new ApiCallAsyncResourceFactory(descriptors.customerGetCustomerMembership, baseClient.customer.getCustomerMembership).getApiResource,
233
- /** List Invites belonging to a Customer. */
234
- listInvitesForCustomer: new ApiCallAsyncResourceFactory(descriptors.customerListInvitesForCustomer, baseClient.customer.listInvitesForCustomer).getApiResource,
233
+ /** Get a customer profile. */
234
+ getCustomer: new ApiCallAsyncResourceFactory(descriptors.customerGetCustomer, baseClient.customer.getCustomer).getApiResource,
235
235
  /** Get a CustomerInvite by token. */
236
236
  getCustomerTokenInvite: new ApiCallAsyncResourceFactory(descriptors.customerGetCustomerTokenInvite, baseClient.customer.getCustomerTokenInvite).getApiResource,
237
+ /** Check if the customer profile has a valid contract partner configured. */
238
+ isCustomerLegallyCompetent: new ApiCallAsyncResourceFactory(descriptors.customerIsCustomerLegallyCompetent, baseClient.customer.isCustomerLegallyCompetent).getApiResource,
239
+ /** List CustomerInvites belonging to the executing user. */
240
+ listCustomerInvites: new ApiCallAsyncResourceFactory(descriptors.customerListCustomerInvites, baseClient.customer.listCustomerInvites).getApiResource,
237
241
  /** List CustomerMemberships belonging to the executing user. */
238
242
  listCustomerMemberships: new ApiCallAsyncResourceFactory(descriptors.customerListCustomerMemberships, baseClient.customer.listCustomerMemberships).getApiResource,
239
243
  /** List Memberships belonging to a Customer. */
240
244
  listMembershipsForCustomer: new ApiCallAsyncResourceFactory(descriptors.customerListMembershipsForCustomer, baseClient.customer.listMembershipsForCustomer).getApiResource,
241
- /** List CustomerInvites belonging to the executing user. */
242
- listCustomerInvites: new ApiCallAsyncResourceFactory(descriptors.customerListCustomerInvites, baseClient.customer.listCustomerInvites).getApiResource,
243
245
  });
244
246
  const buildDatabaseApi = (baseClient) => ({
245
247
  /** List MySQLDatabases belonging to a Project. */
@@ -404,10 +406,26 @@ const buildUserApi = (baseClient) => ({
404
406
  supportCodeRequest: new ApiCallAsyncResourceFactory(descriptors.userSupportCodeRequest, baseClient.user.supportCodeRequest).getApiResource,
405
407
  });
406
408
  const buildProjectApi = (baseClient) => ({
409
+ /** List Invites belonging to a Project. */
410
+ listInvitesForProject: new ApiCallAsyncResourceFactory(descriptors.projectListInvitesForProject, baseClient.project.listInvitesForProject).getApiResource,
411
+ /** Get a ProjectInvite. */
412
+ getProjectInvite: new ApiCallAsyncResourceFactory(descriptors.projectGetProjectInvite, baseClient.project.getProjectInvite).getApiResource,
413
+ /** Get a ProjectMembership */
414
+ getProjectMembership: new ApiCallAsyncResourceFactory(descriptors.projectGetProjectMembership, baseClient.project.getProjectMembership).getApiResource,
407
415
  /** Get a Project. */
408
416
  getProject: new ApiCallAsyncResourceFactory(descriptors.projectGetProject, baseClient.project.getProject).getApiResource,
417
+ /** Get a ProjectInvite by token. */
418
+ getProjectTokenInvite: new ApiCallAsyncResourceFactory(descriptors.projectGetProjectTokenInvite, baseClient.project.getProjectTokenInvite).getApiResource,
419
+ /** Get the executing user's membership in a Project. */
420
+ getSelfMembershipForProject: new ApiCallAsyncResourceFactory(descriptors.projectGetSelfMembershipForProject, baseClient.project.getSelfMembershipForProject).getApiResource,
409
421
  /** Get a Server. */
410
422
  getServer: new ApiCallAsyncResourceFactory(descriptors.projectGetServer, baseClient.project.getServer).getApiResource,
423
+ /** List Memberships belonging to a Project. */
424
+ listMembershipsForProject: new ApiCallAsyncResourceFactory(descriptors.projectListMembershipsForProject, baseClient.project.listMembershipsForProject).getApiResource,
425
+ /** List ProjectInvites belonging to the executing user. */
426
+ listProjectInvites: new ApiCallAsyncResourceFactory(descriptors.projectListProjectInvites, baseClient.project.listProjectInvites).getApiResource,
427
+ /** List ProjectMemberships belonging to the executing user. */
428
+ listProjectMemberships: new ApiCallAsyncResourceFactory(descriptors.projectListProjectMemberships, baseClient.project.listProjectMemberships).getApiResource,
411
429
  /** List Projects belonging to the executing user. */
412
430
  listProjects: new ApiCallAsyncResourceFactory(descriptors.projectListProjects, baseClient.project.listProjects).getApiResource,
413
431
  /** List Servers belonging to the executing user. */
@@ -416,22 +434,6 @@ const buildProjectApi = (baseClient) => ({
416
434
  storagespaceGetProjectStatistics: new ApiCallAsyncResourceFactory(descriptors.storagespaceGetProjectStatistics, baseClient.project.storagespaceGetProjectStatistics).getApiResource,
417
435
  /** Get storage space Statistics belonging to a Server. */
418
436
  storagespaceGetServerStatistics: new ApiCallAsyncResourceFactory(descriptors.storagespaceGetServerStatistics, baseClient.project.storagespaceGetServerStatistics).getApiResource,
419
- /** Get a ProjectInvite. */
420
- getProjectInvite: new ApiCallAsyncResourceFactory(descriptors.projectGetProjectInvite, baseClient.project.getProjectInvite).getApiResource,
421
- /** Get the executing user's membership in a Project. */
422
- getSelfMembershipForProject: new ApiCallAsyncResourceFactory(descriptors.projectGetSelfMembershipForProject, baseClient.project.getSelfMembershipForProject).getApiResource,
423
- /** Get a ProjectMembership */
424
- getProjectMembership: new ApiCallAsyncResourceFactory(descriptors.projectGetProjectMembership, baseClient.project.getProjectMembership).getApiResource,
425
- /** List Invites belonging to a Project. */
426
- listInvitesForProject: new ApiCallAsyncResourceFactory(descriptors.projectListInvitesForProject, baseClient.project.listInvitesForProject).getApiResource,
427
- /** Get a ProjectInvite by token. */
428
- getProjectTokenInvite: new ApiCallAsyncResourceFactory(descriptors.projectGetProjectTokenInvite, baseClient.project.getProjectTokenInvite).getApiResource,
429
- /** List ProjectMemberships belonging to the executing user. */
430
- listProjectMemberships: new ApiCallAsyncResourceFactory(descriptors.projectListProjectMemberships, baseClient.project.listProjectMemberships).getApiResource,
431
- /** List ProjectInvites belonging to the executing user. */
432
- listProjectInvites: new ApiCallAsyncResourceFactory(descriptors.projectListProjectInvites, baseClient.project.listProjectInvites).getApiResource,
433
- /** List Memberships belonging to a Project. */
434
- listMembershipsForProject: new ApiCallAsyncResourceFactory(descriptors.projectListMembershipsForProject, baseClient.project.listMembershipsForProject).getApiResource,
435
437
  });
436
438
  const buildProjectFileSystemApi = (baseClient) => ({
437
439
  /** List directories belonging to a Project. */
@@ -35,8 +35,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
35
35
  };
36
36
  /** The App API allows you to manage your apps within a project, and all the system softwares that are installed as dependencies. */
37
37
  app = {
38
- /** Trigger a runtime action belonging to an AppInstallation. */
39
- executeAction: this.requestFunctionFactory(descriptors.appExecuteAction),
40
38
  /** Get an App. */
41
39
  getApp: this.requestFunctionFactory(descriptors.appGetApp),
42
40
  /** Get an AppInstallation. */
@@ -128,6 +126,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
128
126
  };
129
127
  /** The container API allows you to manage your stacks, containers, volumes and registries. */
130
128
  container = {
129
+ /** Call pull-image webhook */
130
+ callPullImageWebhookForService: this.requestFunctionFactory(descriptors.containerCallPullImageWebhookForService),
131
131
  /** List Registries belonging to a Project. */
132
132
  listRegistries: this.requestFunctionFactory(descriptors.containerListRegistries),
133
133
  /** Create a Registry. */
@@ -170,6 +170,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
170
170
  recreateService: this.requestFunctionFactory(descriptors.containerRecreateService),
171
171
  /** Restart a started Service. */
172
172
  restartService: this.requestFunctionFactory(descriptors.containerRestartService),
173
+ /** Create or rotate pull-image webhook token */
174
+ rotatePullImageWebhookForService: this.requestFunctionFactory(descriptors.containerRotatePullImageWebhookForService),
173
175
  /** Set an update schedule for a Stack. */
174
176
  setStackUpdateSchedule: this.requestFunctionFactory(descriptors.containerSetStackUpdateSchedule),
175
177
  /** Start a stopped Service. */
@@ -431,6 +433,12 @@ export class MittwaldAPIV2Client extends ApiClientBase {
431
433
  };
432
434
  /** The customer API allows you to manage your own organizations and users. */
433
435
  customer = {
436
+ /** Accept a CustomerInvite. */
437
+ acceptCustomerInvite: this.requestFunctionFactory(descriptors.customerAcceptCustomerInvite),
438
+ /** List Invites belonging to a Customer. */
439
+ listInvitesForCustomer: this.requestFunctionFactory(descriptors.customerListInvitesForCustomer),
440
+ /** Create a CustomerInvite. */
441
+ createCustomerInvite: this.requestFunctionFactory(descriptors.customerCreateCustomerInvite),
434
442
  /** Get all customer profiles the authenticated user has access to. */
435
443
  listCustomers: this.requestFunctionFactory(descriptors.customerListCustomers),
436
444
  /** Create a new customer profile. */
@@ -441,18 +449,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
441
449
  getWallet: this.requestFunctionFactory(descriptors.customerGetWallet),
442
450
  /** Create the Wallet for the Customer. */
443
451
  createWallet: this.requestFunctionFactory(descriptors.customerCreateWallet),
444
- /** Get a customer profile. */
445
- getCustomer: this.requestFunctionFactory(descriptors.customerGetCustomer),
446
- /** Update a customer profile. */
447
- updateCustomer: this.requestFunctionFactory(descriptors.customerUpdateCustomer),
448
- /** Delete a customer profile. */
449
- deleteCustomer: this.requestFunctionFactory(descriptors.customerDeleteCustomer),
450
- /** Check if the customer profile has a valid contract partner configured. */
451
- isCustomerLegallyCompetent: this.requestFunctionFactory(descriptors.customerIsCustomerLegallyCompetent),
452
- /** Request a new avatar upload for the customer profile. */
453
- requestAvatarUpload: this.requestFunctionFactory(descriptors.customerRequestAvatarUpload),
454
- /** Remove the avatar picture of the customer profile. */
455
- removeAvatar: this.requestFunctionFactory(descriptors.customerRemoveAvatar),
452
+ /** Decline a CustomerInvite. */
453
+ declineCustomerInvite: this.requestFunctionFactory(descriptors.customerDeclineCustomerInvite),
456
454
  /** Get a CustomerInvite. */
457
455
  getCustomerInvite: this.requestFunctionFactory(descriptors.customerGetCustomerInvite),
458
456
  /** Delete a CustomerInvite. */
@@ -463,22 +461,26 @@ export class MittwaldAPIV2Client extends ApiClientBase {
463
461
  deleteCustomerMembership: this.requestFunctionFactory(descriptors.customerDeleteCustomerMembership),
464
462
  /** Update a CustomerMembership. */
465
463
  updateCustomerMembership: this.requestFunctionFactory(descriptors.customerUpdateCustomerMembership),
466
- /** List Invites belonging to a Customer. */
467
- listInvitesForCustomer: this.requestFunctionFactory(descriptors.customerListInvitesForCustomer),
468
- /** Create a CustomerInvite. */
469
- createCustomerInvite: this.requestFunctionFactory(descriptors.customerCreateCustomerInvite),
470
- /** Accept a CustomerInvite. */
471
- acceptCustomerInvite: this.requestFunctionFactory(descriptors.customerAcceptCustomerInvite),
464
+ /** Get a customer profile. */
465
+ getCustomer: this.requestFunctionFactory(descriptors.customerGetCustomer),
466
+ /** Update a customer profile. */
467
+ updateCustomer: this.requestFunctionFactory(descriptors.customerUpdateCustomer),
468
+ /** Delete a customer profile. */
469
+ deleteCustomer: this.requestFunctionFactory(descriptors.customerDeleteCustomer),
472
470
  /** Get a CustomerInvite by token. */
473
471
  getCustomerTokenInvite: this.requestFunctionFactory(descriptors.customerGetCustomerTokenInvite),
474
- /** Decline a CustomerInvite. */
475
- declineCustomerInvite: this.requestFunctionFactory(descriptors.customerDeclineCustomerInvite),
472
+ /** Check if the customer profile has a valid contract partner configured. */
473
+ isCustomerLegallyCompetent: this.requestFunctionFactory(descriptors.customerIsCustomerLegallyCompetent),
474
+ /** List CustomerInvites belonging to the executing user. */
475
+ listCustomerInvites: this.requestFunctionFactory(descriptors.customerListCustomerInvites),
476
476
  /** List CustomerMemberships belonging to the executing user. */
477
477
  listCustomerMemberships: this.requestFunctionFactory(descriptors.customerListCustomerMemberships),
478
478
  /** List Memberships belonging to a Customer. */
479
479
  listMembershipsForCustomer: this.requestFunctionFactory(descriptors.customerListMembershipsForCustomer),
480
- /** List CustomerInvites belonging to the executing user. */
481
- listCustomerInvites: this.requestFunctionFactory(descriptors.customerListCustomerInvites),
480
+ /** Request a new avatar upload for the customer profile. */
481
+ requestAvatarUpload: this.requestFunctionFactory(descriptors.customerRequestAvatarUpload),
482
+ /** Remove the avatar picture of the customer profile. */
483
+ removeAvatar: this.requestFunctionFactory(descriptors.customerRemoveAvatar),
482
484
  /** Resend the mail for a CustomerInvite. */
483
485
  resendCustomerInviteMail: this.requestFunctionFactory(descriptors.customerResendCustomerInviteMail),
484
486
  };
@@ -884,12 +886,30 @@ export class MittwaldAPIV2Client extends ApiClientBase {
884
886
  };
885
887
  /** The project API allows you to manage your projects, and also any kinds of user memberships concerning these projects. */
886
888
  project = {
889
+ /** Accept a ProjectInvite. */
890
+ acceptProjectInvite: this.requestFunctionFactory(descriptors.projectAcceptProjectInvite),
891
+ /** List Invites belonging to a Project. */
892
+ listInvitesForProject: this.requestFunctionFactory(descriptors.projectListInvitesForProject),
893
+ /** Create a ProjectInvite. */
894
+ createProjectInvite: this.requestFunctionFactory(descriptors.projectCreateProjectInvite),
887
895
  /** Create a Project belonging to a Server. */
888
896
  createProject: this.requestFunctionFactory(descriptors.projectCreateProject),
897
+ /** Decline a ProjectInvite. */
898
+ declineProjectInvite: this.requestFunctionFactory(descriptors.projectDeclineProjectInvite),
889
899
  /** Request a Project avatar upload. */
890
900
  requestProjectAvatarUpload: this.requestFunctionFactory(descriptors.projectRequestProjectAvatarUpload),
891
901
  /** Delete a Project's avatar. */
892
902
  deleteProjectAvatar: this.requestFunctionFactory(descriptors.projectDeleteProjectAvatar),
903
+ /** Get a ProjectInvite. */
904
+ getProjectInvite: this.requestFunctionFactory(descriptors.projectGetProjectInvite),
905
+ /** Delete a ProjectInvite. */
906
+ deleteProjectInvite: this.requestFunctionFactory(descriptors.projectDeleteProjectInvite),
907
+ /** Get a ProjectMembership */
908
+ getProjectMembership: this.requestFunctionFactory(descriptors.projectGetProjectMembership),
909
+ /** Delete a ProjectMembership. */
910
+ deleteProjectMembership: this.requestFunctionFactory(descriptors.projectDeleteProjectMembership),
911
+ /** Update a ProjectMembership. */
912
+ updateProjectMembership: this.requestFunctionFactory(descriptors.projectUpdateProjectMembership),
893
913
  /** Get a Project. */
894
914
  getProject: this.requestFunctionFactory(descriptors.projectGetProject),
895
915
  /** Delete a Project. */
@@ -898,12 +918,24 @@ export class MittwaldAPIV2Client extends ApiClientBase {
898
918
  requestServerAvatarUpload: this.requestFunctionFactory(descriptors.projectRequestServerAvatarUpload),
899
919
  /** Delete a Server's avatar. */
900
920
  deleteServerAvatar: this.requestFunctionFactory(descriptors.projectDeleteServerAvatar),
921
+ /** Get a ProjectInvite by token. */
922
+ getProjectTokenInvite: this.requestFunctionFactory(descriptors.projectGetProjectTokenInvite),
923
+ /** Get the executing user's membership in a Project. */
924
+ getSelfMembershipForProject: this.requestFunctionFactory(descriptors.projectGetSelfMembershipForProject),
901
925
  /** Get a Server. */
902
926
  getServer: this.requestFunctionFactory(descriptors.projectGetServer),
927
+ /** List Memberships belonging to a Project. */
928
+ listMembershipsForProject: this.requestFunctionFactory(descriptors.projectListMembershipsForProject),
929
+ /** List ProjectInvites belonging to the executing user. */
930
+ listProjectInvites: this.requestFunctionFactory(descriptors.projectListProjectInvites),
931
+ /** List ProjectMemberships belonging to the executing user. */
932
+ listProjectMemberships: this.requestFunctionFactory(descriptors.projectListProjectMemberships),
903
933
  /** List Projects belonging to the executing user. */
904
934
  listProjects: this.requestFunctionFactory(descriptors.projectListProjects),
905
935
  /** List Servers belonging to the executing user. */
906
936
  listServers: this.requestFunctionFactory(descriptors.projectListServers),
937
+ /** Resend the mail for a ProjectInvite. */
938
+ resendProjectInviteMail: this.requestFunctionFactory(descriptors.projectResendProjectInviteMail),
907
939
  /** Update a Project's description. */
908
940
  updateProjectDescription: this.requestFunctionFactory(descriptors.projectUpdateProjectDescription),
909
941
  /** Update a Servers's description. */
@@ -916,36 +948,6 @@ export class MittwaldAPIV2Client extends ApiClientBase {
916
948
  storagespaceReplaceProjectNotificationThreshold: this.requestFunctionFactory(descriptors.storagespaceReplaceProjectNotificationThreshold),
917
949
  /** Update a Server's storage space notification threshold. */
918
950
  storagespaceReplaceServerNotificationThreshold: this.requestFunctionFactory(descriptors.storagespaceReplaceServerNotificationThreshold),
919
- /** Resend the mail for a ProjectInvite. */
920
- resendProjectInviteMail: this.requestFunctionFactory(descriptors.projectResendProjectInviteMail),
921
- /** Get a ProjectInvite. */
922
- getProjectInvite: this.requestFunctionFactory(descriptors.projectGetProjectInvite),
923
- /** Delete a ProjectInvite. */
924
- deleteProjectInvite: this.requestFunctionFactory(descriptors.projectDeleteProjectInvite),
925
- /** Decline a ProjectInvite. */
926
- declineProjectInvite: this.requestFunctionFactory(descriptors.projectDeclineProjectInvite),
927
- /** Get the executing user's membership in a Project. */
928
- getSelfMembershipForProject: this.requestFunctionFactory(descriptors.projectGetSelfMembershipForProject),
929
- /** Accept a ProjectInvite. */
930
- acceptProjectInvite: this.requestFunctionFactory(descriptors.projectAcceptProjectInvite),
931
- /** Get a ProjectMembership */
932
- getProjectMembership: this.requestFunctionFactory(descriptors.projectGetProjectMembership),
933
- /** Delete a ProjectMembership. */
934
- deleteProjectMembership: this.requestFunctionFactory(descriptors.projectDeleteProjectMembership),
935
- /** Update a ProjectMembership. */
936
- updateProjectMembership: this.requestFunctionFactory(descriptors.projectUpdateProjectMembership),
937
- /** List Invites belonging to a Project. */
938
- listInvitesForProject: this.requestFunctionFactory(descriptors.projectListInvitesForProject),
939
- /** Create a ProjectInvite. */
940
- createProjectInvite: this.requestFunctionFactory(descriptors.projectCreateProjectInvite),
941
- /** Get a ProjectInvite by token. */
942
- getProjectTokenInvite: this.requestFunctionFactory(descriptors.projectGetProjectTokenInvite),
943
- /** List ProjectMemberships belonging to the executing user. */
944
- listProjectMemberships: this.requestFunctionFactory(descriptors.projectListProjectMemberships),
945
- /** List ProjectInvites belonging to the executing user. */
946
- listProjectInvites: this.requestFunctionFactory(descriptors.projectListProjectInvites),
947
- /** List Memberships belonging to a Project. */
948
- listMembershipsForProject: this.requestFunctionFactory(descriptors.projectListMembershipsForProject),
949
951
  };
950
952
  /** The filesystem API allows you to directly access the filesystem of your project. */
951
953
  projectFileSystem = {