@mittwald/api-client 3.1.19 → 3.1.20

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.
@@ -625,12 +625,14 @@ declare const buildConversationApi: (baseClient: MittwaldAPIV2Client) => {
625
625
  createdBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser | undefined;
626
626
  lastMessageAt?: string | undefined;
627
627
  lastMessageBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser | undefined;
628
+ mainUser: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser;
628
629
  relatedTo?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
629
630
  relations?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference[] | undefined;
630
631
  sharedWith?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
631
632
  shortId: string;
632
633
  status: "open" | "answered" | "closed";
633
634
  title: string;
635
+ visibility: "shared" | "private";
634
636
  }>;
635
637
  /** Request an access token for the File belonging to the Conversation. */
636
638
  getFileAccessToken: (conf: {
@@ -649,6 +651,15 @@ declare const buildConversationApi: (baseClient: MittwaldAPIV2Client) => {
649
651
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
650
652
  } | undefined;
651
653
  } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationCategory[]>;
654
+ /** Get members of a support conversation. */
655
+ getConversationMembers: (conf: {
656
+ conversationId: string;
657
+ headers?: {
658
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
659
+ } | undefined;
660
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<(import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser & {
661
+ active: boolean;
662
+ })[]>;
652
663
  };
653
664
  declare const buildCronjobApi: (baseClient: MittwaldAPIV2Client) => {
654
665
  /** List Cronjobs belonging to a Project. */
@@ -119,6 +119,8 @@ const buildConversationApi = (baseClient) => ({
119
119
  getFileAccessToken: new react_1.ApiCallAsyncResourceFactory(descriptors.conversationGetFileAccessToken, baseClient.conversation.getFileAccessToken).getApiResource,
120
120
  /** Get all conversation categories. */
121
121
  listCategories: new react_1.ApiCallAsyncResourceFactory(descriptors.conversationListCategories, baseClient.conversation.listCategories).getApiResource,
122
+ /** Get members of a support conversation. */
123
+ getConversationMembers: new react_1.ApiCallAsyncResourceFactory(descriptors.conversationGetConversationMembers, baseClient.conversation.getConversationMembers).getApiResource,
122
124
  });
123
125
  const buildCronjobApi = (baseClient) => ({
124
126
  /** List Cronjobs belonging to a Project. */
@@ -2195,14 +2195,27 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
2195
2195
  createConversation: (request?: {
2196
2196
  data?: {
2197
2197
  categoryId?: string | undefined;
2198
+ mainUserId?: string | undefined;
2198
2199
  relatedTo?: {
2199
2200
  aggregate: string;
2200
2201
  domain: string;
2201
2202
  id: string;
2202
2203
  } | undefined;
2203
2204
  sharedWith?: {
2204
- aggregate: string;
2205
- domain: string;
2205
+ aggregate: "user";
2206
+ domain: "user";
2207
+ id: string;
2208
+ } | {
2209
+ aggregate: "customer";
2210
+ domain: "customer";
2211
+ id: string;
2212
+ } | {
2213
+ aggregate: "project";
2214
+ domain: "project";
2215
+ id: string;
2216
+ } | {
2217
+ aggregate: "placementgroup";
2218
+ domain: "project";
2206
2219
  id: string;
2207
2220
  } | undefined;
2208
2221
  title?: string | undefined;
@@ -2213,8 +2226,9 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
2213
2226
  } | null | undefined) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
2214
2227
  data: {
2215
2228
  categoryId?: string | undefined;
2229
+ mainUserId?: string | undefined;
2216
2230
  relatedTo?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
2217
- sharedWith?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
2231
+ sharedWith?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationShareableAggregateReference | undefined;
2218
2232
  title?: string | undefined;
2219
2233
  };
2220
2234
  } & {
@@ -2322,12 +2336,14 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
2322
2336
  createdBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser | undefined;
2323
2337
  lastMessageAt?: string | undefined;
2324
2338
  lastMessageBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser | undefined;
2339
+ mainUser: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser;
2325
2340
  relatedTo?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
2326
2341
  relations?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference[] | undefined;
2327
2342
  sharedWith?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
2328
2343
  shortId: string;
2329
2344
  status: "open" | "answered" | "closed";
2330
2345
  title: string;
2346
+ visibility: "shared" | "private";
2331
2347
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
2332
2348
  [x: string]: unknown;
2333
2349
  }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
@@ -2505,6 +2521,29 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
2505
2521
  }, 403, "application/json"> | import("@mittwald/api-client-commons").Response<{
2506
2522
  [x: string]: unknown;
2507
2523
  }, 404, "application/json">>>;
2524
+ /** Get members of a support conversation. */
2525
+ getConversationMembers: (request: {
2526
+ conversationId: string;
2527
+ headers?: {
2528
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2529
+ } | undefined;
2530
+ }) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
2531
+ headers?: Partial<{
2532
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
2533
+ }> | undefined;
2534
+ } & {
2535
+ pathParameters: {
2536
+ conversationId: string;
2537
+ };
2538
+ }, import("@mittwald/api-client-commons").Response<(import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser & {
2539
+ active: boolean;
2540
+ })[], 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
2541
+ [x: string]: unknown;
2542
+ }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
2543
+ [x: string]: unknown;
2544
+ }, 403, "application/json"> | import("@mittwald/api-client-commons").Response<{
2545
+ [x: string]: unknown;
2546
+ }, 404, "application/json">>>;
2508
2547
  };
2509
2548
  /** The cronjob API allows you to manage cronjobs within a project. */
2510
2549
  readonly cronjob: {
@@ -190,6 +190,8 @@ class MittwaldAPIV2Client extends api_client_commons_1.ApiClientBase {
190
190
  setConversationStatus: this.requestFunctionFactory(descriptors.conversationSetConversationStatus),
191
191
  /** Update the content of the message */
192
192
  updateMessage: this.requestFunctionFactory(descriptors.conversationUpdateMessage),
193
+ /** Get members of a support conversation. */
194
+ getConversationMembers: this.requestFunctionFactory(descriptors.conversationGetConversationMembers),
193
195
  };
194
196
  /** The cronjob API allows you to manage cronjobs within a project. */
195
197
  this.cronjob = {
@@ -589,3 +589,5 @@ export declare const userVerifyPhoneNumber: OpenAPIOperation<RequestType<Simplif
589
589
  export declare const userVerifyRegistration: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Responses.$200.Content.Empty>, 200, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
590
590
  /** Request an Access Token for the Invoice file. */
591
591
  export declare const invoiceGetFileAccessToken: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdInvoicesInvoiceIdFileAccessToken.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdInvoicesInvoiceIdFileAccessToken.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdInvoicesInvoiceIdFileAccessToken.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdInvoicesInvoiceIdFileAccessToken.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdInvoicesInvoiceIdFileAccessToken.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdInvoicesInvoiceIdFileAccessToken.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdInvoicesInvoiceIdFileAccessToken.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
592
+ /** Get members of a support conversation. */
593
+ export declare const conversationGetConversationMembers: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
@@ -5,7 +5,7 @@ exports.databaseCreateMysqlDatabase = exports.databaseListMysqlDatabases = expor
5
5
  exports.fileGetFileUploadTokenRules = exports.fileGetFileMeta = exports.fileCreateFile = exports.domainVerifyDomainOwnership = exports.domainUpdateDomainProjectId = exports.domainUpdateDomainContact = exports.domainUpdateDomainAuthCode = exports.domainResendDomainEmail = exports.domainListTlds = exports.domainListTldContactSchemas = exports.domainListDomains = exports.domainListDomainOwnerships = exports.domainGetLatestScreenshot = exports.domainGetDomainOwnership = exports.domainDeleteDomain = exports.domainGetDomain = exports.domainUpdateDomainNameservers = exports.domainCreateDomainAuthCode = exports.domainCreateDomainAuthCode2 = exports.domainCheckDomainRegistrability = exports.domainAbortDomainDeclaration = exports.dnsUpdateRecordSet = exports.dnsSetRecordSetManaged = exports.dnsListDnsZones = exports.dnsDeleteDnsZone = exports.dnsGetDnsZone = exports.dnsCreateDnsZone = exports.newsletterSubscribeUser = exports.databaseUpdateRedisDatabaseDescription = exports.databaseUpdateRedisDatabaseConfiguration = exports.databaseUpdateMysqlUserPassword = exports.databaseUpdateMysqlDatabaseDescription = exports.databaseUpdateMysqlDatabaseDefaultCharset = exports.databaseListRedisVersions = exports.databaseListMysqlVersions = exports.databaseListMysqlCharsets = exports.databaseGetMysqlUserPhpMyAdminUrl = exports.databaseEnableMysqlUser = exports.databaseDisableMysqlUser = exports.databaseDeleteRedisDatabase = exports.databaseGetRedisDatabase = exports.databaseDeleteMysqlUser = exports.databaseUpdateMysqlUser = exports.databaseGetMysqlUser = exports.databaseDeleteMysqlDatabase = exports.databaseGetMysqlDatabase = exports.databaseCreateRedisDatabase = exports.databaseListRedisDatabases = exports.databaseCreateMysqlUser = exports.databaseListMysqlUsers = void 0;
6
6
  exports.projectCreateProjectInvite = exports.projectAcceptProjectInvite = exports.passwordValidationGetPasswordPolicy = exports.pageinsightsListPerformanceDataForProject = exports.pageinsightsGetPerformanceData = exports.orderPreviewTariffChange = exports.orderPreviewOrder = exports.orderListProjectOrders = exports.orderListCustomerOrders = exports.orderGetOrder = exports.orderCreateTariffChange = exports.orderCreateOrder = exports.notificationsReadNotification = exports.notificationsReadAllNotifications = exports.notificationsListNotifications = exports.notificationsCountUnreadNotifications = exports.newsletterUnsubscribeUser = exports.newsletterGetInfo = exports.mailUpdateProjectMailSetting = exports.mailUpdateMailAddressSpamProtection = exports.mailUpdateMailAddressQuota = exports.mailUpdateMailAddressPassword = exports.mailUpdateMailAddressForwardAddresses = exports.mailUpdateMailAddressCatchAll = exports.mailUpdateMailAddressAutoresponder = exports.mailUpdateMailAddressAddress = exports.mailUpdateDeliveryBoxPassword = exports.mailUpdateDeliveryBoxDescription = exports.mailListProjectMailSettings = exports.mailCreateMailAddress = exports.mailListMailAddresses = exports.mailCreateDeliverybox = exports.mailListDeliveryBoxes = exports.mailDeleteMailAddress = exports.mailGetMailAddress = exports.mailDeleteDeliveryBox = exports.mailGetDeliveryBox = exports.invoiceListCustomerInvoices = exports.invoiceUpdateInvoiceSettings = exports.invoiceGetDetailOfInvoiceSettings = exports.invoiceDetailOfInvoice = exports.ingressUpdateIngressTls = exports.ingressRequestIngressAcmeCertificateIssuance = exports.ingressUpdateIngressPaths = exports.ingressDeleteIngress = exports.ingressGetIngress = exports.ingressCreateIngress = exports.ingressListIngresses = exports.fileGetFile = exports.fileGetFileUploadTypeRules = void 0;
7
7
  exports.userChangeEmail = exports.userGetOwnEmail = exports.userAuthenticate = exports.userAuthenticateMfa = exports.userRemovePhoneNumber = exports.userAddPhoneNumber = exports.sshUserUpdateSshUser = exports.sshUserDeleteSshUser = exports.sshUserGetSshUser = exports.sshUserCreateSshUser = exports.sshUserListSshUsers = exports.sftpUserUpdateSftpUser = exports.sftpUserDeleteSftpUser = exports.sftpUserGetSftpUser = exports.sftpUserCreateSftpUser = exports.sftpUserListSftpUsers = exports.servicetokenAuthenticateService = exports.relocationCreateRelocation = exports.relocationCreateLegacyTariffChange = exports.projectUpdateServerDescription = exports.projectUpdateProjectDescription = exports.projectResendProjectInviteMail = exports.projectListServers = exports.projectListProjects = exports.projectListProjectMemberships = exports.projectListProjectInvites = exports.projectListMembershipsForProject = exports.projectListInvitesForProject = exports.projectLeaveProject = exports.projectGetServer = exports.projectGetSelfMembershipForProject = exports.projectGetProjectTokenInvite = exports.projectFileSystemListFiles = exports.projectFileSystemGetJwt = exports.projectFileSystemGetFileContent = exports.projectFileSystemGetDiskUsage = exports.projectFileSystemGetDirectories = exports.projectDeleteServerAvatar = exports.projectRequestServerAvatarUpload = exports.projectDeleteProject = exports.projectGetProject = exports.projectUpdateProjectMembership = exports.projectDeleteProjectMembership = exports.projectGetProjectMembership = exports.projectDeleteProjectInvite = exports.projectGetProjectInvite = exports.projectDeleteProjectAvatar = exports.projectRequestProjectAvatarUpload = exports.projectDeclineProjectInvite = exports.projectCreateProject = void 0;
8
- exports.invoiceGetFileAccessToken = exports.userVerifyRegistration = exports.userVerifyPhoneNumber = exports.userVerifyEmail = exports.userSupportCodeRequest = exports.userResendVerificationEmail = exports.userRemoveAvatar = exports.userRequestAvatarUpload = exports.userRegister = exports.userLogout = exports.userTerminateAllSessions = exports.userListSessions = exports.userListFeedback = exports.userInitPasswordReset = exports.userInitMfa = exports.userUpdatePersonalInformation = exports.userGetUser = exports.userTerminateSession = exports.userGetSession = exports.userUpdatePersonalizedSettings = exports.userGetPersonalizedSettings = exports.userGetPasswordUpdatedAt = exports.userUpdateAccount = exports.userGetOwnAccount = exports.userDeleteUser = exports.userDeleteSshKey = exports.userEditSshKey = exports.userGetSshKey = exports.userDeleteApiToken = exports.userEditApiToken = exports.userGetApiToken = exports.userCreateSshKey = exports.userListSshKeys = exports.userCreateFeedback = exports.userCreateApiToken = exports.userListApiTokens = exports.userConfirmPasswordReset = exports.userDisableMfa = exports.userConfirmMfa = exports.userResetRecoverycodes = exports.userGetMfaStatus = exports.userCheckToken = exports.userChangePassword = void 0;
8
+ exports.conversationGetConversationMembers = exports.invoiceGetFileAccessToken = exports.userVerifyRegistration = exports.userVerifyPhoneNumber = exports.userVerifyEmail = exports.userSupportCodeRequest = exports.userResendVerificationEmail = exports.userRemoveAvatar = exports.userRequestAvatarUpload = exports.userRegister = exports.userLogout = exports.userTerminateAllSessions = exports.userListSessions = exports.userListFeedback = exports.userInitPasswordReset = exports.userInitMfa = exports.userUpdatePersonalInformation = exports.userGetUser = exports.userTerminateSession = exports.userGetSession = exports.userUpdatePersonalizedSettings = exports.userGetPersonalizedSettings = exports.userGetPasswordUpdatedAt = exports.userUpdateAccount = exports.userGetOwnAccount = exports.userDeleteUser = exports.userDeleteSshKey = exports.userEditSshKey = exports.userGetSshKey = exports.userDeleteApiToken = exports.userEditApiToken = exports.userGetApiToken = exports.userCreateSshKey = exports.userListSshKeys = exports.userCreateFeedback = exports.userCreateApiToken = exports.userListApiTokens = exports.userConfirmPasswordReset = exports.userDisableMfa = exports.userConfirmMfa = exports.userResetRecoverycodes = exports.userGetMfaStatus = exports.userCheckToken = exports.userChangePassword = void 0;
9
9
  /** Execute a runtime concerning action on a specific `AppInstallation`. */
10
10
  exports.appExecuteAction = {
11
11
  path: "/v2/app-installations/{appInstallationId}/actions/{action}",
@@ -1764,3 +1764,9 @@ exports.invoiceGetFileAccessToken = {
1764
1764
  method: "GET",
1765
1765
  operationId: "invoice-get-file-access-token",
1766
1766
  };
1767
+ /** Get members of a support conversation. */
1768
+ exports.conversationGetConversationMembers = {
1769
+ path: "/v2/conversations/{conversationId}/members",
1770
+ method: "GET",
1771
+ operationId: "conversation-get-conversation-members",
1772
+ };
@@ -1174,6 +1174,10 @@ export declare module MittwaldAPIV2 {
1174
1174
  type RequestData = InferredRequestData<typeof descriptors.invoiceGetFileAccessToken>;
1175
1175
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.invoiceGetFileAccessToken, TStatus>;
1176
1176
  }
1177
+ namespace ConversationGetConversationMembers {
1178
+ type RequestData = InferredRequestData<typeof descriptors.conversationGetConversationMembers>;
1179
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.conversationGetConversationMembers, TStatus>;
1180
+ }
1177
1181
  }
1178
1182
  namespace Components {
1179
1183
  namespace Schemas {
@@ -1642,12 +1646,14 @@ export declare module MittwaldAPIV2 {
1642
1646
  createdBy?: MittwaldAPIV2.Components.Schemas.ConversationUser;
1643
1647
  lastMessageAt?: string;
1644
1648
  lastMessageBy?: MittwaldAPIV2.Components.Schemas.ConversationUser;
1649
+ mainUser: MittwaldAPIV2.Components.Schemas.ConversationUser;
1645
1650
  relatedTo?: MittwaldAPIV2.Components.Schemas.ConversationAggregateReference;
1646
1651
  relations?: MittwaldAPIV2.Components.Schemas.ConversationAggregateReference[];
1647
1652
  sharedWith?: MittwaldAPIV2.Components.Schemas.ConversationAggregateReference;
1648
1653
  shortId: string;
1649
1654
  status: "open" | "closed" | "answered";
1650
1655
  title: string;
1656
+ visibility: "shared" | "private";
1651
1657
  }
1652
1658
  interface ConversationGetConversationIdResponse {
1653
1659
  conversationId: string;
@@ -1696,6 +1702,7 @@ export declare module MittwaldAPIV2 {
1696
1702
  type: "STATUS_UPDATE";
1697
1703
  }
1698
1704
  interface ConversationUser {
1705
+ active?: boolean;
1699
1706
  avatarRefId?: string;
1700
1707
  clearName?: string;
1701
1708
  department?: MittwaldAPIV2.Components.Schemas.ConversationDepartment;
@@ -2926,6 +2933,26 @@ export declare module MittwaldAPIV2 {
2926
2933
  location?: MittwaldAPIV2.Components.Schemas.SignupLocation;
2927
2934
  tokenId: string;
2928
2935
  }
2936
+ type ConversationConversationMembers = (MittwaldAPIV2.Components.Schemas.ConversationUser & {
2937
+ active: boolean;
2938
+ })[];
2939
+ type ConversationShareableAggregateReference = {
2940
+ aggregate: "user";
2941
+ domain: "user";
2942
+ id: string;
2943
+ } | {
2944
+ aggregate: "customer";
2945
+ domain: "customer";
2946
+ id: string;
2947
+ } | {
2948
+ aggregate: "project";
2949
+ domain: "project";
2950
+ id: string;
2951
+ } | {
2952
+ aggregate: "placementgroup";
2953
+ domain: "project";
2954
+ id: string;
2955
+ };
2929
2956
  interface CommonsAddress {
2930
2957
  street: string;
2931
2958
  houseNumber: string;
@@ -4939,8 +4966,9 @@ export declare module MittwaldAPIV2 {
4939
4966
  type Path = {};
4940
4967
  interface RequestBody {
4941
4968
  categoryId?: string;
4969
+ mainUserId?: string;
4942
4970
  relatedTo?: MittwaldAPIV2.Components.Schemas.ConversationAggregateReference;
4943
- sharedWith?: MittwaldAPIV2.Components.Schemas.ConversationAggregateReference;
4971
+ sharedWith?: MittwaldAPIV2.Components.Schemas.ConversationShareableAggregateReference;
4944
4972
  title?: string;
4945
4973
  }
4946
4974
  type Header = {};
@@ -7812,9 +7840,6 @@ export declare module MittwaldAPIV2 {
7812
7840
  }
7813
7841
  }
7814
7842
  namespace V2AppinstallationsAppInstallationIdDatabases { }
7815
- namespace V2DomainsDomainIdContracts { }
7816
- namespace V2ProjectsProjectIdContracts { }
7817
- namespace V2ServersServerIdContracts { }
7818
7843
  namespace V2DomainsDomainIdScreenshotsNewest { }
7819
7844
  namespace V2FileTokenRulesToken { }
7820
7845
  namespace V2FileTypeRulesName { }
@@ -14820,5 +14845,51 @@ export declare module MittwaldAPIV2 {
14820
14845
  }
14821
14846
  }
14822
14847
  }
14848
+ namespace V2ConversationsConversationIdMembers {
14849
+ namespace Get {
14850
+ namespace Parameters {
14851
+ type Path = {
14852
+ conversationId: string;
14853
+ };
14854
+ type Header = {};
14855
+ type Query = {};
14856
+ }
14857
+ namespace Responses {
14858
+ namespace $200 {
14859
+ namespace Content {
14860
+ type ApplicationJson = MittwaldAPIV2.Components.Schemas.ConversationConversationMembers;
14861
+ }
14862
+ }
14863
+ namespace $400 {
14864
+ namespace Content {
14865
+ interface ApplicationJson {
14866
+ [k: string]: unknown;
14867
+ }
14868
+ }
14869
+ }
14870
+ namespace $403 {
14871
+ namespace Content {
14872
+ interface ApplicationJson {
14873
+ [k: string]: unknown;
14874
+ }
14875
+ }
14876
+ }
14877
+ namespace $404 {
14878
+ namespace Content {
14879
+ interface ApplicationJson {
14880
+ [k: string]: unknown;
14881
+ }
14882
+ }
14883
+ }
14884
+ namespace Default {
14885
+ namespace Content {
14886
+ interface ApplicationJson {
14887
+ [k: string]: unknown;
14888
+ }
14889
+ }
14890
+ }
14891
+ }
14892
+ }
14893
+ }
14823
14894
  }
14824
14895
  }
@@ -625,12 +625,14 @@ declare const buildConversationApi: (baseClient: MittwaldAPIV2Client) => {
625
625
  createdBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser | undefined;
626
626
  lastMessageAt?: string | undefined;
627
627
  lastMessageBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser | undefined;
628
+ mainUser: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser;
628
629
  relatedTo?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
629
630
  relations?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference[] | undefined;
630
631
  sharedWith?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
631
632
  shortId: string;
632
633
  status: "open" | "answered" | "closed";
633
634
  title: string;
635
+ visibility: "shared" | "private";
634
636
  }>;
635
637
  /** Request an access token for the File belonging to the Conversation. */
636
638
  getFileAccessToken: (conf: {
@@ -649,6 +651,15 @@ declare const buildConversationApi: (baseClient: MittwaldAPIV2Client) => {
649
651
  [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
650
652
  } | undefined;
651
653
  } | null | undefined) => import("@mittwald/react-use-promise/types").AsyncResource<import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationCategory[]>;
654
+ /** Get members of a support conversation. */
655
+ getConversationMembers: (conf: {
656
+ conversationId: string;
657
+ headers?: {
658
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
659
+ } | undefined;
660
+ }) => import("@mittwald/react-use-promise/types").AsyncResource<(import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser & {
661
+ active: boolean;
662
+ })[]>;
652
663
  };
653
664
  declare const buildCronjobApi: (baseClient: MittwaldAPIV2Client) => {
654
665
  /** List Cronjobs belonging to a Project. */
@@ -90,6 +90,8 @@ const buildConversationApi = (baseClient) => ({
90
90
  getFileAccessToken: new ApiCallAsyncResourceFactory(descriptors.conversationGetFileAccessToken, baseClient.conversation.getFileAccessToken).getApiResource,
91
91
  /** Get all conversation categories. */
92
92
  listCategories: new ApiCallAsyncResourceFactory(descriptors.conversationListCategories, baseClient.conversation.listCategories).getApiResource,
93
+ /** Get members of a support conversation. */
94
+ getConversationMembers: new ApiCallAsyncResourceFactory(descriptors.conversationGetConversationMembers, baseClient.conversation.getConversationMembers).getApiResource,
93
95
  });
94
96
  const buildCronjobApi = (baseClient) => ({
95
97
  /** List Cronjobs belonging to a Project. */
@@ -2195,14 +2195,27 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
2195
2195
  createConversation: (request?: {
2196
2196
  data?: {
2197
2197
  categoryId?: string | undefined;
2198
+ mainUserId?: string | undefined;
2198
2199
  relatedTo?: {
2199
2200
  aggregate: string;
2200
2201
  domain: string;
2201
2202
  id: string;
2202
2203
  } | undefined;
2203
2204
  sharedWith?: {
2204
- aggregate: string;
2205
- domain: string;
2205
+ aggregate: "user";
2206
+ domain: "user";
2207
+ id: string;
2208
+ } | {
2209
+ aggregate: "customer";
2210
+ domain: "customer";
2211
+ id: string;
2212
+ } | {
2213
+ aggregate: "project";
2214
+ domain: "project";
2215
+ id: string;
2216
+ } | {
2217
+ aggregate: "placementgroup";
2218
+ domain: "project";
2206
2219
  id: string;
2207
2220
  } | undefined;
2208
2221
  title?: string | undefined;
@@ -2213,8 +2226,9 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
2213
2226
  } | null | undefined) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
2214
2227
  data: {
2215
2228
  categoryId?: string | undefined;
2229
+ mainUserId?: string | undefined;
2216
2230
  relatedTo?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
2217
- sharedWith?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
2231
+ sharedWith?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationShareableAggregateReference | undefined;
2218
2232
  title?: string | undefined;
2219
2233
  };
2220
2234
  } & {
@@ -2322,12 +2336,14 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
2322
2336
  createdBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser | undefined;
2323
2337
  lastMessageAt?: string | undefined;
2324
2338
  lastMessageBy?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser | undefined;
2339
+ mainUser: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser;
2325
2340
  relatedTo?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
2326
2341
  relations?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference[] | undefined;
2327
2342
  sharedWith?: import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationAggregateReference | undefined;
2328
2343
  shortId: string;
2329
2344
  status: "open" | "answered" | "closed";
2330
2345
  title: string;
2346
+ visibility: "shared" | "private";
2331
2347
  }, 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
2332
2348
  [x: string]: unknown;
2333
2349
  }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
@@ -2505,6 +2521,29 @@ export declare class MittwaldAPIV2Client extends ApiClientBase {
2505
2521
  }, 403, "application/json"> | import("@mittwald/api-client-commons").Response<{
2506
2522
  [x: string]: unknown;
2507
2523
  }, 404, "application/json">>>;
2524
+ /** Get members of a support conversation. */
2525
+ getConversationMembers: (request: {
2526
+ conversationId: string;
2527
+ headers?: {
2528
+ [x: string]: (string | number | boolean) | (string | number | boolean)[] | undefined;
2529
+ } | undefined;
2530
+ }) => import("@mittwald/api-client-commons").ResponsePromise<import("@mittwald/api-client-commons").OpenAPIOperation<{
2531
+ headers?: Partial<{
2532
+ [TKey: string]: (string | number | boolean) | (string | number | boolean)[];
2533
+ }> | undefined;
2534
+ } & {
2535
+ pathParameters: {
2536
+ conversationId: string;
2537
+ };
2538
+ }, import("@mittwald/api-client-commons").Response<(import("./types.js").MittwaldAPIV2.Components.Schemas.ConversationUser & {
2539
+ active: boolean;
2540
+ })[], 200, "application/json"> | import("@mittwald/api-client-commons").Response<{
2541
+ [x: string]: unknown;
2542
+ }, 400, "application/json"> | import("@mittwald/api-client-commons").Response<{
2543
+ [x: string]: unknown;
2544
+ }, 403, "application/json"> | import("@mittwald/api-client-commons").Response<{
2545
+ [x: string]: unknown;
2546
+ }, 404, "application/json">>>;
2508
2547
  };
2509
2548
  /** The cronjob API allows you to manage cronjobs within a project. */
2510
2549
  readonly cronjob: {
@@ -162,6 +162,8 @@ export class MittwaldAPIV2Client extends ApiClientBase {
162
162
  setConversationStatus: this.requestFunctionFactory(descriptors.conversationSetConversationStatus),
163
163
  /** Update the content of the message */
164
164
  updateMessage: this.requestFunctionFactory(descriptors.conversationUpdateMessage),
165
+ /** Get members of a support conversation. */
166
+ getConversationMembers: this.requestFunctionFactory(descriptors.conversationGetConversationMembers),
165
167
  };
166
168
  /** The cronjob API allows you to manage cronjobs within a project. */
167
169
  cronjob = {
@@ -589,3 +589,5 @@ export declare const userVerifyPhoneNumber: OpenAPIOperation<RequestType<Simplif
589
589
  export declare const userVerifyRegistration: OpenAPIOperation<RequestType<Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Parameters.RequestBody>, Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Responses.$200.Content.Empty>, 200, "empty"> | Response<Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2VerifyRegistration.Post.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
590
590
  /** Request an Access Token for the Invoice file. */
591
591
  export declare const invoiceGetFileAccessToken: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdInvoicesInvoiceIdFileAccessToken.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdInvoicesInvoiceIdFileAccessToken.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdInvoicesInvoiceIdFileAccessToken.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdInvoicesInvoiceIdFileAccessToken.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdInvoicesInvoiceIdFileAccessToken.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdInvoicesInvoiceIdFileAccessToken.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2CustomersCustomerIdInvoicesInvoiceIdFileAccessToken.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
592
+ /** Get members of a support conversation. */
593
+ export declare const conversationGetConversationMembers: OpenAPIOperation<RequestType<Simplify<null>, Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Parameters.Path>, Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Parameters.Query>, Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Parameters.Header>>, Response<Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Responses.$200.Content.ApplicationJson>, 200, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Responses.$400.Content.ApplicationJson>, 400, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Responses.$403.Content.ApplicationJson>, 403, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Responses.$404.Content.ApplicationJson>, 404, "application/json"> | Response<Simplify<MittwaldAPIV2.Paths.V2ConversationsConversationIdMembers.Get.Responses.Default.Content.ApplicationJson>, "default", "application/json">>;
@@ -1756,3 +1756,9 @@ export const invoiceGetFileAccessToken = {
1756
1756
  method: "GET",
1757
1757
  operationId: "invoice-get-file-access-token",
1758
1758
  };
1759
+ /** Get members of a support conversation. */
1760
+ export const conversationGetConversationMembers = {
1761
+ path: "/v2/conversations/{conversationId}/members",
1762
+ method: "GET",
1763
+ operationId: "conversation-get-conversation-members",
1764
+ };
@@ -1174,6 +1174,10 @@ export declare module MittwaldAPIV2 {
1174
1174
  type RequestData = InferredRequestData<typeof descriptors.invoiceGetFileAccessToken>;
1175
1175
  type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.invoiceGetFileAccessToken, TStatus>;
1176
1176
  }
1177
+ namespace ConversationGetConversationMembers {
1178
+ type RequestData = InferredRequestData<typeof descriptors.conversationGetConversationMembers>;
1179
+ type ResponseData<TStatus extends HttpStatus = 200> = InferredResponseData<typeof descriptors.conversationGetConversationMembers, TStatus>;
1180
+ }
1177
1181
  }
1178
1182
  namespace Components {
1179
1183
  namespace Schemas {
@@ -1642,12 +1646,14 @@ export declare module MittwaldAPIV2 {
1642
1646
  createdBy?: MittwaldAPIV2.Components.Schemas.ConversationUser;
1643
1647
  lastMessageAt?: string;
1644
1648
  lastMessageBy?: MittwaldAPIV2.Components.Schemas.ConversationUser;
1649
+ mainUser: MittwaldAPIV2.Components.Schemas.ConversationUser;
1645
1650
  relatedTo?: MittwaldAPIV2.Components.Schemas.ConversationAggregateReference;
1646
1651
  relations?: MittwaldAPIV2.Components.Schemas.ConversationAggregateReference[];
1647
1652
  sharedWith?: MittwaldAPIV2.Components.Schemas.ConversationAggregateReference;
1648
1653
  shortId: string;
1649
1654
  status: "open" | "closed" | "answered";
1650
1655
  title: string;
1656
+ visibility: "shared" | "private";
1651
1657
  }
1652
1658
  interface ConversationGetConversationIdResponse {
1653
1659
  conversationId: string;
@@ -1696,6 +1702,7 @@ export declare module MittwaldAPIV2 {
1696
1702
  type: "STATUS_UPDATE";
1697
1703
  }
1698
1704
  interface ConversationUser {
1705
+ active?: boolean;
1699
1706
  avatarRefId?: string;
1700
1707
  clearName?: string;
1701
1708
  department?: MittwaldAPIV2.Components.Schemas.ConversationDepartment;
@@ -2926,6 +2933,26 @@ export declare module MittwaldAPIV2 {
2926
2933
  location?: MittwaldAPIV2.Components.Schemas.SignupLocation;
2927
2934
  tokenId: string;
2928
2935
  }
2936
+ type ConversationConversationMembers = (MittwaldAPIV2.Components.Schemas.ConversationUser & {
2937
+ active: boolean;
2938
+ })[];
2939
+ type ConversationShareableAggregateReference = {
2940
+ aggregate: "user";
2941
+ domain: "user";
2942
+ id: string;
2943
+ } | {
2944
+ aggregate: "customer";
2945
+ domain: "customer";
2946
+ id: string;
2947
+ } | {
2948
+ aggregate: "project";
2949
+ domain: "project";
2950
+ id: string;
2951
+ } | {
2952
+ aggregate: "placementgroup";
2953
+ domain: "project";
2954
+ id: string;
2955
+ };
2929
2956
  interface CommonsAddress {
2930
2957
  street: string;
2931
2958
  houseNumber: string;
@@ -4939,8 +4966,9 @@ export declare module MittwaldAPIV2 {
4939
4966
  type Path = {};
4940
4967
  interface RequestBody {
4941
4968
  categoryId?: string;
4969
+ mainUserId?: string;
4942
4970
  relatedTo?: MittwaldAPIV2.Components.Schemas.ConversationAggregateReference;
4943
- sharedWith?: MittwaldAPIV2.Components.Schemas.ConversationAggregateReference;
4971
+ sharedWith?: MittwaldAPIV2.Components.Schemas.ConversationShareableAggregateReference;
4944
4972
  title?: string;
4945
4973
  }
4946
4974
  type Header = {};
@@ -7812,9 +7840,6 @@ export declare module MittwaldAPIV2 {
7812
7840
  }
7813
7841
  }
7814
7842
  namespace V2AppinstallationsAppInstallationIdDatabases { }
7815
- namespace V2DomainsDomainIdContracts { }
7816
- namespace V2ProjectsProjectIdContracts { }
7817
- namespace V2ServersServerIdContracts { }
7818
7843
  namespace V2DomainsDomainIdScreenshotsNewest { }
7819
7844
  namespace V2FileTokenRulesToken { }
7820
7845
  namespace V2FileTypeRulesName { }
@@ -14820,5 +14845,51 @@ export declare module MittwaldAPIV2 {
14820
14845
  }
14821
14846
  }
14822
14847
  }
14848
+ namespace V2ConversationsConversationIdMembers {
14849
+ namespace Get {
14850
+ namespace Parameters {
14851
+ type Path = {
14852
+ conversationId: string;
14853
+ };
14854
+ type Header = {};
14855
+ type Query = {};
14856
+ }
14857
+ namespace Responses {
14858
+ namespace $200 {
14859
+ namespace Content {
14860
+ type ApplicationJson = MittwaldAPIV2.Components.Schemas.ConversationConversationMembers;
14861
+ }
14862
+ }
14863
+ namespace $400 {
14864
+ namespace Content {
14865
+ interface ApplicationJson {
14866
+ [k: string]: unknown;
14867
+ }
14868
+ }
14869
+ }
14870
+ namespace $403 {
14871
+ namespace Content {
14872
+ interface ApplicationJson {
14873
+ [k: string]: unknown;
14874
+ }
14875
+ }
14876
+ }
14877
+ namespace $404 {
14878
+ namespace Content {
14879
+ interface ApplicationJson {
14880
+ [k: string]: unknown;
14881
+ }
14882
+ }
14883
+ }
14884
+ namespace Default {
14885
+ namespace Content {
14886
+ interface ApplicationJson {
14887
+ [k: string]: unknown;
14888
+ }
14889
+ }
14890
+ }
14891
+ }
14892
+ }
14893
+ }
14823
14894
  }
14824
14895
  }
package/dist/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const MittwaldAPIClientVersion = '3.1.19';
1
+ export declare const MittwaldAPIClientVersion = '3.1.20';
package/dist/version.js CHANGED
@@ -1 +1 @@
1
- export const MittwaldAPIClientVersion = '3.1.19';
1
+ export const MittwaldAPIClientVersion = '3.1.20';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mittwald/api-client",
3
- "version": "3.1.19",
3
+ "version": "3.1.20",
4
4
  "description": "Auto-generated client for the mittwald API",
5
5
  "license": "MIT",
6
6
  "repository": "github:mittwald/api-client-js",